cat master API

cat master API

New API reference

For the most up-to-date API details, refer to Compact and aligned text (CAT) APIs..

cat APIs are only intended for human consumption using the command line or Kibana console. They are not intended for use by applications. For application consumption, use the nodes info API.

Returns information about the master node, including the ID, bound IP address, and name.

Request

GET /_cat/master

Prerequisites

  • If the Elasticsearch security features are enabled, you must have the monitor or manage cluster privilege to use this API.

Query parameters

format

(Optional, string) Short version of the HTTP accept header. Valid values include JSON, YAML, etc.

h

(Optional, string) Comma-separated list of column names to display.

help

(Optional, Boolean) If true, the response includes help information. Defaults to false.

local

(Optional, Boolean) If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.

master_timeout

(Optional, time units) Period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. Defaults to 30s. Can also be set to -1 to indicate that the request should never timeout.

s

(Optional, string) Comma-separated list of column names or column aliases used to sort the response.

v

(Optional, Boolean) If true, the response includes column headings. Defaults to false.

Examples

  1. resp = client.cat.master(
  2.     v=True,
  3. )
  4. print(resp)
  1. response = client.cat.master(
  2.   v: true
  3. )
  4. puts response
  1. const response = await client.cat.master({
  2.   v: "true",
  3. });
  4. console.log(response);
  1. GET /_cat/master?v=true

The API returns the following response:

  1. id                     host      ip        node
  2. YzWoH_2BT-6UjVGDyPdqYg 127.0.0.1 127.0.0.1 YzWoH_2

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:

  1. % pssh -i -h list.of.cluster.hosts curl -s localhost:9200/_cat/master
  2. [1] 19:16:37 [SUCCESS] es3.vm
  3. Ntgn2DcuTjGuXlhKDUD4vA 192.168.56.30 H5dfFeA
  4. [2] 19:16:37 [SUCCESS] es2.vm
  5. Ntgn2DcuTjGuXlhKDUD4vA 192.168.56.30 H5dfFeA
  6. [3] 19:16:37 [SUCCESS] es1.vm
  7. Ntgn2DcuTjGuXlhKDUD4vA 192.168.56.30 H5dfFeA