Skip to content

Commit 841d961

Browse files
authored
[DOCS] Document CCS-supported APIs (#52708)
Explicitly notes the Elasticsearch API endpoints that support CCS. This should deter users from attempting to use CCS with other API endpoints, such as `GET <index>/_doc/<_id>`.
1 parent cc00fd7 commit 841d961

File tree

1 file changed

+18
-8
lines changed

1 file changed

+18
-8
lines changed

docs/reference/modules/cross-cluster-search.asciidoc

+18-8
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,17 @@ filter and analyze log data stored on clusters in different data centers.
88

99
IMPORTANT: {ccs-cap} requires <<modules-remote-clusters, remote clusters>>.
1010

11+
[float]
12+
[[ccs-supported-apis]]
13+
== Supported APIs
14+
15+
The following APIs support {ccs}:
16+
17+
* <<search-search,Search>>
18+
* <<search-multi-search,Multi search>>
19+
* <<search-template,Search template>>
20+
* <<multi-search-template,Multi search template>>
21+
1122
[float]
1223
[[ccs-example]]
1324
== {ccs-cap} examples
@@ -55,7 +66,7 @@ PUT _cluster/settings
5566
[[ccs-search-remote-cluster]]
5667
=== Search a single remote cluster
5768

58-
The following <<search,search>> API request searches the
69+
The following <<search-search,search>> API request searches the
5970
`twitter` index on a single remote cluster, `cluster_one`.
6071

6172
[source,console]
@@ -280,13 +291,12 @@ including a <<request-body-search-scroll, scroll>> or
280291
+
281292
See <<ccs-min-roundtrips>> to learn how this option works.
282293

283-
<<ccs-unmin-roundtrips, Don't minimize network roundtrips>>::
284-
For search requests that include a scroll or inner hits, {es} sends multiple
285-
outgoing and ingoing requests to each remote cluster. You can also choose this
286-
option by setting the <<search,search>> API's
287-
<<ccs-minimize-roundtrips,`ccs_minimize_roundtrips`>> parameter to `false`.
288-
While typically slower, this approach may work well for networks with low
289-
latency.
294+
<<ccs-unmin-roundtrips, Don't minimize network roundtrips>>:: For search
295+
requests that include a scroll or inner hits, {es} sends multiple outgoing and
296+
ingoing requests to each remote cluster. You can also choose this option by
297+
setting the <<ccs-minimize-roundtrips,`ccs_minimize_roundtrips`>> parameter to
298+
`false`. While typically slower, this approach may work well for networks with
299+
low latency.
290300
+
291301
See <<ccs-unmin-roundtrips>> to learn how this option works.
292302

0 commit comments

Comments
 (0)