@@ -16,8 +16,9 @@ with this endpoint.
1616
1717For each cluster in the index expression, information is returned about:
1818
19- 1. whether the querying ("local") cluster is currently connected to each remote cluster
20- in the index expression scope
19+ 1. whether the querying ("local") cluster was able to connect to each remote cluster
20+ specified in the index expression. Note that this endpoint actively attempts to
21+ contact the remote clusters, unlike the <<cluster-remote-info,remote/info>> endpoint.
21222. whether each remote cluster is configured with `skip_unavailable` as `true` or `false`
22233. whether there are any indices, aliases or data streams on that cluster that match
2324 the index expression
@@ -110,8 +111,21 @@ ignored when frozen. Defaults to `false`.
110111deprecated:[7.16.0]
111112
112113
113- [discrete]
114114[[usecases-for-resolve-cluster]]
115+
116+ === Test availability of remote clusters
117+
118+ The <<cluster-remote-info,remote/info>> endpoint is commonly used to test whether the "local"
119+ cluster (the cluster being queried) is connected to its remote clusters, but it does not
120+ necessarily reflect whether the remote cluster is available or not. The remote cluster may
121+ be available, while the local cluster is not currently connected to it.
122+
123+ You can use this API to force a reconnection (for example with `GET _resolve/cluster/*:*`) and
124+ examine the `connected` field in the response for each remote. This will also cause the
125+ <<cluster-remote-info,remote/info>> endpoint to now reflect the fact that a connection has
126+ been (re-)established.
127+
128+
115129=== Advantages of using this endpoint before a {ccs}
116130
117131You may want to exclude a cluster or index from a search when:
@@ -195,7 +209,6 @@ The API returns the following response:
195209<5> The Elasticsearch server version.
196210
197211
198- [discrete]
199212[[resolve-cluster-api-error-example]]
200213==== Identifying potential problems with your {ccs}
201214
0 commit comments