-
Notifications
You must be signed in to change notification settings - Fork 332
/
Copy pathrest-fts.dita
81 lines (80 loc) · 4.23 KB
/
rest-fts.dita
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic PUBLIC "-//OASIS//DTD DITA Topic//EN" "topic.dtd">
<topic id="topic_ytp_sx4_1v">
<title>Full Text Search API</title>
<body>
<note>The REST APIs for Full Text Search are experimental in this release. Any aspect may change
significantly in the future.</note>
<p>For Full Text Search, the REST endpoints below can be reached on port 8094, or 18094 when
using SSL. If running in a multi-node environment, you have to connect to a node with Full
Text service enabled.</p>
<p>For more information on required roles and permissions, please consult <xref
href="../security/concepts-rba.dita#concept_ntl_jph_hr"/>. Granting users the appropriate
role automatically assigns the required permissions, which are listed here for information
purposes since you may see them in the audit log, for example.</p>
<section><title>Indexing</title>
<p><b>Index Definition</b>
<ul>
<li><xref href="rest-fts-indexing.dita#topic_hpd_2y4_1v/g-api-index"/></li>
<li><xref href="rest-fts-indexing.dita#topic_hpd_2y4_1v/g-api-index-name"/></li>
<li><xref href="rest-fts-indexing.dita#topic_hpd_2y4_1v/p-api-index-name"/></li>
<li><xref href="rest-fts-indexing.dita#topic_hpd_2y4_1v/d-api-index-name"/></li> </ul></p>
<p><b>Index Management</b><ul>
<li><xref href="rest-fts-indexing.dita#topic_hpd_2y4_1v/p-api-idx-name-ingestcontrol"
/></li>
<li><xref
href="rest-fts-indexing.dita#topic_hpd_2y4_1v/p-api-idx-name-planfreezecontrol"
/></li>
<li><xref href="rest-fts-indexing.dita#topic_hpd_2y4_1v/p-api-idx-name-querycontrol"
/></li></ul> </p>
<p><b>Index Monitoring</b><ul>
<li><xref href="rest-fts-indexing.dita#topic_hpd_2y4_1v/g-api-stats"/></li>
<li><xref href="rest-fts-indexing.dita#topic_hpd_2y4_1v/g-api-stats-index-name"/></li>
</ul> </p>
<p><b>Index Querying</b><ul>
<li><xref href="rest-fts-indexing.dita#topic_hpd_2y4_1v/g-api-index-name-count"/></li>
<li><xref href="rest-fts-indexing.dita#topic_hpd_2y4_1v/p-api-index-name-query"/>
</li></ul> </p>
</section>
<section><title>Node</title>
<p><b>Node Configuration</b><ul>
<li><xref href="rest-fts-node.dita#topic_ykd_my4_1v/g-api-cfg"/></li>
<li><xref href="rest-fts-node.dita#topic_ykd_my4_1v/p-api-cfgrefresh"/></li>
<li><xref href="rest-fts-node.dita#topic_ykd_my4_1v/p-api-mgrkick"/></li>
<li><xref href="rest-fts-node.dita#topic_ykd_my4_1v/g-api-mgrmeta"/></li> </ul>
</p>
<p><b>Node Diagnostics</b><ul>
<li><xref href="rest-fts-node.dita#topic_ykd_my4_1v/g-api-diag"/></li>
<li><xref href="rest-fts-node.dita#topic_ykd_my4_1v/g-api-log"/></li>
<li><xref href="rest-fts-node.dita#topic_ykd_my4_1v/g-api-runtime"/></li>
<li><xref href="rest-fts-node.dita#topic_ykd_my4_1v/g-api-runtime-args"/></li>
<li><xref href="rest-fts-node.dita#topic_ykd_my4_1v/p-api-runtime-cpu"/></li>
<li><xref href="rest-fts-node.dita#topic_ykd_my4_1v/p-api-runtime-memory"/></li>
</ul>
</p>
<p><b>Node Management</b><ul>
<li><xref href="rest-fts-node.dita#topic_ykd_my4_1v/p-api-runtime-gc"/></li>
</ul>
</p>
<p><b>Node Monitoring</b><ul>
<li><xref href="rest-fts-node.dita#topic_ykd_my4_1v/g-api-runtime-stats"/></li>
<li><xref href="rest-fts-node.dita#topic_ykd_my4_1v/g-api-runtime-statsmem"/></li>
</ul>
</p>
</section>
<section><title>Advanced</title>
<p><b>Index Partition Definition</b><ul>
<li><xref href="rest-fts-advanced.dita#topic_lhc_sy4_1v/g-api-index"/></li>
<li><xref href="rest-fts-advanced.dita#topic_lhc_sy4_1v/g-api-index-name"/></li></ul>
</p>
<p><b>Index Partition Querying</b><ul>
<li><xref href="rest-fts-advanced.dita#topic_lhc_sy4_1v/g-api-index-name-count"/></li>
<li><xref href="rest-fts-advanced.dita#topic_lhc_sy4_1v/p-api-index-name-query"/></li>
</ul></p>
<p><b>FTS Memory Quota</b><ul>
<li><xref href="rest-fts-advanced.dita#topic_lhc_sy4_1v/p-api-fts-memory-quota"/></li>
</ul>
</p>
</section>
</body>
</topic>