From 07b0650128bc31b5dbdbb09b00609a0b179a66ca Mon Sep 17 00:00:00 2001 From: aetter Date: Wed, 22 Sep 2021 12:59:25 -0700 Subject: [PATCH] Add remote cluster information operation --- _opensearch/rest-api/remote-info.md | 40 +++++++++++++++++++++++++++++ 1 file changed, 40 insertions(+) create mode 100644 _opensearch/rest-api/remote-info.md diff --git a/_opensearch/rest-api/remote-info.md b/_opensearch/rest-api/remote-info.md new file mode 100644 index 00000000..e9d88402 --- /dev/null +++ b/_opensearch/rest-api/remote-info.md @@ -0,0 +1,40 @@ +--- +layout: default +title: Remote cluster information +parent: REST API reference +nav_order: 25 +--- + +# Remote cluster information +Introduced 1.0 +{: .label .label-purple } + +This operation provides connection information for any remote OpenSearch clusters that you've configured for the local cluster, such as the remote cluster alias, connection mode (`sniff` or `proxy`), IP addresses for seed nodes, and timeout settings. + +The response is more comprehensive and useful than a call to `_cluster/settings`, which only includes the cluster alias and seed nodes. + + +## Path and HTTP methods + +``` +GET _remote/info +``` + + +## Response + +```json +{ + "opensearch-cluster2": { + "connected": true, + "mode": "sniff", + "seeds": [ + "172.28.0.2:9300" + ], + "num_nodes_connected": 1, + "max_connections_per_cluster": 3, + "initial_connect_timeout": "30s", + "skip_unavailable": false + } +} +```