91 lines
3.0 KiB
Plaintext
91 lines
3.0 KiB
Plaintext
[[cluster-remote-info]]
|
|
=== Remote cluster info API
|
|
++++
|
|
<titleabbrev>Remote cluster info</titleabbrev>
|
|
++++
|
|
|
|
.New API reference
|
|
[sidebar]
|
|
--
|
|
For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs].
|
|
--
|
|
|
|
Returns configured remote cluster information.
|
|
|
|
[[cluster-remote-info-api-request]]
|
|
==== {api-request-title}
|
|
|
|
`GET /_remote/info`
|
|
|
|
[[cluster-remote-info-api-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
* If the {es} {security-features} are enabled, you must have the `monitor` or
|
|
`manage` <<privileges-list-cluster,cluster privilege>> to use this API.
|
|
|
|
[[cluster-remote-info-api-desc]]
|
|
==== {api-description-title}
|
|
|
|
The cluster remote info API allows you to retrieve information about configured
|
|
remote clusters. It returns connection and endpoint information keyed
|
|
by the configured remote cluster alias.
|
|
|
|
TIP: This API returns information that reflects current state on the local cluster.
|
|
The `connected` field does not necessarily reflect whether a remote cluster is
|
|
down or unavailable, only whether there is currently an open connection to it.
|
|
Elasticsearch does not spontaneously try to reconnect to a disconnected remote
|
|
cluster. To trigger a reconnection, attempt a <<modules-cross-cluster-search,{ccs}>>,
|
|
<<esql-cross-clusters,{esql} {ccs}>>, or try the
|
|
<<indices-resolve-cluster-api,resolve cluster>> endpoint.
|
|
|
|
|
|
[[cluster-remote-info-api-response-body]]
|
|
==== {api-response-body-title}
|
|
|
|
`mode`::
|
|
Connection mode for the remote cluster. Returned values are `sniff` and
|
|
`proxy`.
|
|
|
|
`connected`::
|
|
True if there is at least one open connection to the remote cluster. When
|
|
false, it means that the cluster no longer has an open connection to the
|
|
remote cluster. It does not necessarily mean that the remote cluster is
|
|
down or unavailable, just that at some point a connection was lost.
|
|
|
|
`initial_connect_timeout`::
|
|
The initial connect timeout for remote cluster connections.
|
|
|
|
[[skip-unavailable]]
|
|
`skip_unavailable`::
|
|
Whether a {ccs} skips the remote cluster if its nodes are unavailable during the
|
|
search. If `true`, a {ccs} also ignores errors returned by the remote cluster.
|
|
Refer to <<skip-unavailable-clusters>>.
|
|
|
|
`seeds`::
|
|
Initial seed transport addresses of the remote cluster when sniff mode is
|
|
configured.
|
|
|
|
`num_nodes_connected`::
|
|
Number of connected nodes in the remote cluster when sniff mode is
|
|
configured.
|
|
|
|
`max_connections_per_cluster`::
|
|
Maximum number of connections maintained for the remote cluster when sniff
|
|
mode is configured.
|
|
|
|
`proxy_address`::
|
|
Address for remote connections when proxy mode is configured.
|
|
|
|
`num_proxy_sockets_connected`::
|
|
Number of open socket connections to the remote cluster when proxy mode
|
|
is configured.
|
|
|
|
`max_proxy_socket_connections`::
|
|
The maximum number of socket connections to the remote cluster when proxy
|
|
mode is configured.
|
|
|
|
`cluster_credentials`::
|
|
This field presents and has value of `::es_redacted::` only when the
|
|
<<remote-clusters-api-key,remote cluster is configured with the API key based model>>.
|
|
Otherwise, the field is not present.
|