mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-06-28 17:34:17 -04:00
33a71e3289
* Remove `es-test-dir` book-scoped variable * Remove `plugins-examples-dir` book-scoped variable * Remove `:dependencies-dir:` and `:xes-repo-dir:` book-scoped variables - In `index.asciidoc`, two variables (`:dependencies-dir:` and `:xes-repo-dir:`) were removed. - In `sql/index.asciidoc`, the `:sql-tests:` path was updated to fuller path - In `esql/index.asciidoc`, the `:esql-tests:` path was updated idem * Replace `es-repo-dir` with `es-ref-dir` * Move `:include-xpack: true` to few files that use it, remove from index.asciidoc
78 lines
2.3 KiB
Text
78 lines
2.3 KiB
Text
[[cat-master]]
|
|
=== cat master API
|
|
++++
|
|
<titleabbrev>cat master</titleabbrev>
|
|
++++
|
|
|
|
[IMPORTANT]
|
|
====
|
|
cat APIs are only intended for human consumption using the command line or {kib}
|
|
console. They are _not_ intended for use by applications. For application
|
|
consumption, use the <<cluster-nodes-info,nodes info API>>.
|
|
====
|
|
|
|
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-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
* If the {es} {security-features} are enabled, you must have the `monitor` or
|
|
`manage` <<privileges-list-cluster,cluster privilege>> to use this API.
|
|
|
|
[[cat-master-api-query-params]]
|
|
==== {api-query-parms-title}
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=http-format]
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-h]
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=help]
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=local]
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=master-timeout]
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-s]
|
|
|
|
include::{es-ref-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
|
|
|
|
|
|
[[cat-master-api-example]]
|
|
==== {api-examples-title}
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
GET /_cat/master?v=true
|
|
--------------------------------------------------
|
|
|
|
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
|