elasticsearch/docs/reference/modules/cluster/remote-clusters-remote-info.asciidoc
Abdon Pijpelink 0421c4fe9b
[DOCS] Remote cluster troubleshooting guide (#99128)
* [DOCS] Remote cluster troubleshooting guide

* Fix test failures

* Apply suggestions from code review

Co-authored-by: Yang Wang <ywangd@gmail.com>

* Review feedback

* Group issues under 'common' and 'API key'

* Apply suggestions from code review

Co-authored-by: Yang Wang <ywangd@gmail.com>

---------

Co-authored-by: Yang Wang <ywangd@gmail.com>
2023-09-05 15:10:45 +02:00

32 lines
No EOL
860 B
Text

[source,console]
----
GET /_remote/info
----
// TEST[skip:TODO]
The API should return `"connected" : true`. When using
<<remote-clusters-api-key,API key authentication>>, it should also return
`"cluster_credentials": "::es_redacted::"`.
[source,console-result,subs=attributes+]
----
{
"cluster_one" : {
"seeds" : [
"127.0.0.1:9443"
],
"connected" : true, <1>
"num_nodes_connected" : 1,
"max_connections_per_cluster" : 3,
"initial_connect_timeout" : "30s",
"skip_unavailable" : false,
"cluster_credentials": "::es_redacted::", <2>
"mode" : "sniff"
}
}
----
// TEST[skip:TODO]
<1> The remote cluster has connected successfully.
<2> If present, indicates the remote cluster has connected using
<<remote-clusters-api-key,API key authentication>> instead of
<<remote-clusters-cert,certificate based authentication>>.