@@ -11,7 +11,9 @@ For the most up-to-date API details, refer to {api-es}/group/endpoint-indices[In
1111--
1212
1313Resolves the specified index expressions to return information about
14- each cluster, including the local cluster, if included.
14+ each cluster, including the local "querying" cluster, if included. If no index expression
15+ is provided, this endpoint will return information about all the remote
16+ clusters that are configured on the querying cluster.
1517
1618This endpoint is useful before doing a <<modules-cross-cluster-search,{ccs}>> in
1719order to determine which remote clusters should be included in a search.
@@ -20,14 +22,13 @@ You use the same index expression with this endpoint as you would for cross-clus
2022search. Index and <<exclude-problematic-clusters,cluster exclusions>> are also supported
2123with this endpoint.
2224
23- For each cluster in the index expression , information is returned about:
25+ For each cluster in scope , information is returned about:
2426
25- 1. whether the querying ("local") cluster is currently connected to each remote cluster
26- in the index expression scope
27+ 1. whether the querying ("local") cluster is currently connected to it
27282. whether each remote cluster is configured with `skip_unavailable` as `true` or `false`
28293. whether there are any indices, aliases or data streams on that cluster that match
29- the index expression
30- 4. whether the search is likely to have errors returned when you do the {ccs} (including any
30+ the index expression (if one provided)
31+ 4. whether the search is likely to have errors returned when you do a {ccs} (including any
3132 authorization errors if your user does not have permission to query a remote cluster or
3233 the indices on that cluster)
33345. (in some cases) cluster version information, including the Elasticsearch server version
@@ -41,6 +42,11 @@ Once the proper security permissions are obtained, then you can rely on the `con
4142in the response to determine whether the remote cluster is available and ready for querying.
4243====
4344
45+ NOTE: When querying older clusters that do not support the _resolve/cluster endpoint
46+ without an index expression, the local cluster will send the index expression `dummy*`
47+ to those remote clusters, so if an errors occur, you may see a reference to that index
48+ expression even though you didn't request it. If it causes a problem, you can instead
49+ include an index expression like `*:*` to this endpoint to bypass the issue.
4450
4551////
4652[source,console]
@@ -71,14 +77,22 @@ PUT _cluster/settings
7177// TEST[s/35.238.149.\d+:930\d+/\${transport_host}/]
7278////
7379
80+ [source,console]
81+ ----
82+ GET /_resolve/cluster
83+ ----
84+ // TEST[continued]
85+
86+ Returns information about all remote clusters configured on the local cluster.
87+
7488[source,console]
7589----
7690GET /_resolve/cluster/my-index-*,cluster*:my-index-*
7791----
7892// TEST[continued]
7993
80- This will return information about the local cluster and all remotely configured
81- clusters that start with the alias `cluster*`. Each cluster will return information
94+ Returns information about the local cluster and all remote clusters that
95+ start with the alias `cluster*`. Each cluster will return information
8296about whether it has any indices, aliases or data streams that match `my-index-*`.
8397
8498[[resolve-cluster-api-request]]
@@ -126,6 +140,13 @@ ignored when frozen. Defaults to `false`.
126140+
127141deprecated:[7.16.0]
128142
143+ [TIP]
144+ ====
145+ The index options above are only allowed when specifying an index expression.
146+ You will get an error if you specify index options to the _resolve/cluster API
147+ that takes no index expression.
148+ ====
149+
129150
130151[discrete]
131152[[usecases-for-resolve-cluster]]
0 commit comments