The cluster state API allows to get a comprehensive state information of the whole cluster.
The response provides the cluster name, the total compressed size of the cluster state (its size when serialized for transmission over the network), and the cluster state itself, which can be filtered to only retrieve the parts of interest, as described below.
cluster_uuid is also returned as part of the top-level
response, in addition to the
Added in 6.4.0.
While the cluster is still forming, it is possible for the
_na_ as well as the cluster state’s version to be
By default, the cluster state request is routed to the master node, to
ensure that the latest cluster state is returned.
For debugging purposes, you can retrieve the cluster state local to a
particular node by adding
local=true to the query string.
As the cluster state can grow (depending on the number of shards and indices, your mapping, templates), it is possible to filter the cluster state response specifying the parts in the URL.
metrics can be a comma-separated list of
- Shows the cluster state version.
Shows the elected
master_nodepart of the response
nodespart of the response
routing_tablepart of the response. If you supply a comma separated list of indices, the returned output will only contain the indices listed.
metadatapart of the response. If you supply a comma separated list of indices, the returned output will only contain the indices listed.
blockspart of the response
The following example returns only
routing_table data for the
The next example returns everything for the
And this example return only