Cluster state #

Returns an internal representation of the cluster state for debugging or diagnostic purposes.

Note: despite its name, GET /_cluster/state currently returns the local region’s state — one region entry, not a cluster-wide aggregation. Remote regions cannot be queried yet.

Get the whole cluster state #

Requests #

GET /_cluster/state/<names>

Path Parameters #

• names
  (Optional, string) A comma-separated list of the following options:

  • _all
    Shows all names.
  • blocks
    Accepted for Elasticsearch compatibility but not implemented yet — filtering on it returns nothing.
  • leader_node
    Shows the leader_node part of the response.
  • metadata
    Shows the metadata part of the response.
  • nodes
    Shows the nodes part of the response.
  • routing_nodes
    Shows the routing_nodes part of the response.
  • routing_table
    Shows the routing_table part of the response.
  • version
    Accepted for Elasticsearch compatibility but not implemented yet — filtering on it returns nothing.

Get the state of a specific region #

Requests #

GET /_cluster/_region/<region_id>/state/<names>

Path parameters #

• region_id
  (Required, String) The region to query. Currently only the special ID _local — the region that handles this request — is implemented; a remote region UUID answers 501 not implemented yet.

• names
  (Optional, string) A comma-separated list of options, see the names parameter of the cluster state API for the full list of options.