Remote cluster info API
Returns configured remote cluster information.
Request
GET /_remote/info
Prerequisites
- If the Elasticsearch security features are enabled, you must have the
monitorormanagecluster privilege to use this API.
Description
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.
Response body
-
mode - Connection mode for the remote cluster. Returned values are
sniffandproxy. -
connected - True if there is at least one connection to the remote cluster.
-
initial_connect_timeout - The initial connect timeout for remote cluster connections.
-
skip_unavailable - Whether a cross-cluster search skips the remote cluster if its nodes are unavailable during the search. If
true, a cross-cluster search also ignores errors returned by the remote cluster. Refer to Optional remote 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.
© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/7.17/cluster-remote-info.html
