OpenSearch/docs/reference/cat/master.asciidoc

67 lines
1.8 KiB
Plaintext

[[cat-master]]
=== cat master API
++++
<titleabbrev>cat master</titleabbrev>
++++
Returns information about the master node, including the ID, bound IP address,
and name.
[[cat-master-api-request]]
==== {api-request-title}
`GET /_cat/master`
[[cat-master-api-query-params]]
==== {api-query-parms-title}
include::{docdir}/rest-api/common-parms.asciidoc[tag=http-format]
include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-h]
include::{docdir}/rest-api/common-parms.asciidoc[tag=help]
include::{docdir}/rest-api/common-parms.asciidoc[tag=local]
include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout]
include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-s]
include::{docdir}/rest-api/common-parms.asciidoc[tag=cat-v]
[[cat-master-api-example]]
==== {api-examples-title}
[source,console]
--------------------------------------------------
GET /_cat/master?v
--------------------------------------------------
The API returns the following response:
[source,txt]
--------------------------------------------------
id host ip node
YzWoH_2BT-6UjVGDyPdqYg 127.0.0.1 127.0.0.1 YzWoH_2
--------------------------------------------------
// TESTRESPONSE[s/YzWoH_2.+/.+/ non_json]
This information is also available via the `nodes` command, but this
is slightly shorter when all you want to do, for example, is verify
all nodes agree on the master:
[source,sh]
--------------------------------------------------
% pssh -i -h list.of.cluster.hosts curl -s localhost:9200/_cat/master
[1] 19:16:37 [SUCCESS] es3.vm
Ntgn2DcuTjGuXlhKDUD4vA 192.168.56.30 H5dfFeA
[2] 19:16:37 [SUCCESS] es2.vm
Ntgn2DcuTjGuXlhKDUD4vA 192.168.56.30 H5dfFeA
[3] 19:16:37 [SUCCESS] es1.vm
Ntgn2DcuTjGuXlhKDUD4vA 192.168.56.30 H5dfFeA
--------------------------------------------------
// NOTCONSOLE