Get node attribute information

GET /_cat/nodeattrs

Get information about custom node attributes. IMPORTANT: 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.

Query parameters

local boolean

If true, the request computes the list of selected nodes from the local cluster state. If false the list of selected nodes are computed from the cluster state of the master node. In both cases the coordinating node will send requests for further information to each selected node.
master_timeout string

Period to wait for a connection to the master node.

Responses

200

application/json

application/json text/plain
Hide response attributes Show response attributes object
- node string
  
  The node name.
- id string
  
  The unique node identifier.
- pid string
  
  The process identifier.
- host string
  
  The host name.
- ip string
  
  The IP address.
- port string
  
  The bound transport port.
- attr string
  
  The attribute name.
- value string
  
  The attribute value.

GET /_cat/nodeattrs

curl \
 --request GET http://api.example.com/_cat/nodeattrs \
 --header "Authorization: $API_KEY"

Response examples (200)

[
  {
    "node": "string",
    "id": "string",
    "pid": "string",
    "host": "string",
    "ip": "string",
    "port": "string",
    "attr": "string",
    "value": "string"
  }
]

Response examples (200)

A successful response from `GET /_cat/nodeattrs?v=true`. The `node`, `host`, and `ip` columns provide basic information about each node. The `attr` and `value` columns return custom node attributes, one per line.

node    host      ip        attr     value
node-0 127.0.0.1 127.0.0.1 testattr test

A successful response from `GET /_cat/nodeattrs?v=true&h=name,pid,attr,value`. It returns the `name`, `pid`, `attr`, and `value` columns.

name    pid   attr     value
node-0 19566 testattr test