123456789101112131415161718192021222324252627282930313233343536373839404142434445 |
- [[cluster-remote-info]]
- === Remote cluster info API
- ++++
- <titleabbrev>Remote cluster info</titleabbrev>
- ++++
- Returns configured remote cluster information.
- [[cluster-remote-info-api-request]]
- ==== {api-request-title}
- `GET /_remote/info`
- [[cluster-remote-info-api-desc]]
- ==== {api-description-title}
- The cluster remote info API allows you to retrieve all of the configured
- remote cluster information. It returns connection and endpoint information keyed
- by the configured remote cluster alias.
- [[cluster-remote-info-api-response-body]]
- ==== {api-response-body-title}
- `seeds`::
- The configured initial seed transport addresses of the remote cluster.
- `connected`::
- True if there is at least one connection to the remote cluster.
- `num_nodes_connected`::
- The number of connected nodes in the remote cluster.
- `max_connections_per_cluster`::
- The maximum number of connections maintained for the remote cluster.
- `initial_connect_timeout`::
- The initial connect timeout for remote cluster connections.
- [[skip-unavailable]]
- `skip_unavailable`::
- Whether the remote cluster is skipped in case it is searched through
- a {ccs} request but none of its nodes are available.
|