mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-25 22:36:20 +00:00
a63f60b776
Several files in the REST APIs nav section are included using :leveloffset: tags. This increments headings (h2 -> h3, h3 -> h4, etc.) in those files and removes the :leveloffset: tags. Other supporting changes: * Alphabetizes top-level REST API nav items. * Change 'indices APIs' heading to 'index APIs.' * Changes 'Snapshot lifecycle management' heading to sentence case.
37 lines
981 B
Plaintext
37 lines
981 B
Plaintext
[[cluster-remote-info]]
|
|
=== Remote Cluster Info
|
|
|
|
The cluster remote info API allows to retrieve all of the configured
|
|
remote cluster information.
|
|
|
|
[source,js]
|
|
----------------------------------
|
|
GET /_remote/info
|
|
----------------------------------
|
|
// CONSOLE
|
|
|
|
This command returns connection and endpoint information keyed by
|
|
the configured remote cluster alias.
|
|
|
|
[float]
|
|
[[connection-info]]
|
|
|
|
`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`::
|
|
Whether the remote cluster is skipped in case it is searched through
|
|
a {ccs} request but none of its nodes are available.
|