2013-11-14 20:14:39 -05:00
|
|
|
[[cat-master]]
|
2019-08-13 08:35:08 -04:00
|
|
|
=== cat master API
|
|
|
|
++++
|
|
|
|
<titleabbrev>cat master</titleabbrev>
|
|
|
|
++++
|
2013-11-14 20:14:39 -05:00
|
|
|
|
2019-08-07 09:03:31 -04:00
|
|
|
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}
|
|
|
|
|
2020-06-01 19:42:53 -04:00
|
|
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=http-format]
|
2019-08-07 09:03:31 -04:00
|
|
|
|
2020-06-01 19:42:53 -04:00
|
|
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
|
2019-08-07 09:03:31 -04:00
|
|
|
|
2020-06-01 19:42:53 -04:00
|
|
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=help]
|
2019-08-07 09:03:31 -04:00
|
|
|
|
2020-06-01 19:42:53 -04:00
|
|
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=local]
|
2019-08-07 09:03:31 -04:00
|
|
|
|
2020-06-01 19:42:53 -04:00
|
|
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
|
2019-08-07 09:03:31 -04:00
|
|
|
|
2020-06-01 19:42:53 -04:00
|
|
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
|
2019-08-07 09:03:31 -04:00
|
|
|
|
2020-06-01 19:42:53 -04:00
|
|
|
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
|
2019-08-07 09:03:31 -04:00
|
|
|
|
|
|
|
|
|
|
|
[[cat-master-api-example]]
|
|
|
|
==== {api-examples-title}
|
2013-11-14 20:14:39 -05:00
|
|
|
|
2019-09-09 13:38:14 -04:00
|
|
|
[source,console]
|
2013-11-14 20:14:39 -05:00
|
|
|
--------------------------------------------------
|
2016-10-13 16:42:21 -04:00
|
|
|
GET /_cat/master?v
|
|
|
|
--------------------------------------------------
|
|
|
|
|
2019-08-07 09:03:31 -04:00
|
|
|
The API returns the following response:
|
2016-10-13 16:42:21 -04:00
|
|
|
|
2016-10-25 10:56:30 -04:00
|
|
|
[source,txt]
|
2016-10-13 16:42:21 -04:00
|
|
|
--------------------------------------------------
|
|
|
|
id host ip node
|
|
|
|
YzWoH_2BT-6UjVGDyPdqYg 127.0.0.1 127.0.0.1 YzWoH_2
|
2013-11-14 20:14:39 -05:00
|
|
|
--------------------------------------------------
|
2019-06-10 09:33:32 -04:00
|
|
|
// TESTRESPONSE[s/YzWoH_2.+/.+/ non_json]
|
2013-11-14 20:14:39 -05:00
|
|
|
|
|
|
|
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:
|
|
|
|
|
2015-07-14 12:14:09 -04:00
|
|
|
[source,sh]
|
2013-11-14 20:14:39 -05:00
|
|
|
--------------------------------------------------
|
|
|
|
% pssh -i -h list.of.cluster.hosts curl -s localhost:9200/_cat/master
|
|
|
|
[1] 19:16:37 [SUCCESS] es3.vm
|
2016-09-16 08:32:03 -04:00
|
|
|
Ntgn2DcuTjGuXlhKDUD4vA 192.168.56.30 H5dfFeA
|
2013-11-14 20:14:39 -05:00
|
|
|
[2] 19:16:37 [SUCCESS] es2.vm
|
2016-09-16 08:32:03 -04:00
|
|
|
Ntgn2DcuTjGuXlhKDUD4vA 192.168.56.30 H5dfFeA
|
2013-11-14 20:14:39 -05:00
|
|
|
[3] 19:16:37 [SUCCESS] es1.vm
|
2016-09-16 08:32:03 -04:00
|
|
|
Ntgn2DcuTjGuXlhKDUD4vA 192.168.56.30 H5dfFeA
|
2013-11-14 20:14:39 -05:00
|
|
|
--------------------------------------------------
|
2016-10-13 16:42:21 -04:00
|
|
|
// NOTCONSOLE
|