79 lines
2.5 KiB
Plaintext
79 lines
2.5 KiB
Plaintext
[[cluster-state]]
|
|
== Cluster State
|
|
|
|
The cluster state API allows to get a comprehensive state information of
|
|
the whole cluster.
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET /_cluster/state
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
|
|
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.
|
|
|
|
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.
|
|
|
|
[float]
|
|
=== Response Filters
|
|
|
|
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.
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET /_cluster/state/{metrics}/{indices}
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
|
|
`metrics` can be a comma-separated list of
|
|
|
|
`version`::
|
|
Shows the cluster state version.
|
|
|
|
`master_node`::
|
|
Shows the elected `master_node` part of the response
|
|
|
|
`nodes`::
|
|
Shows the `nodes` part of the response
|
|
|
|
`routing_table`::
|
|
Shows the `routing_table` part of the response. If you supply a comma separated list of indices, the returned output will only contain the indices listed.
|
|
|
|
`metadata`::
|
|
Shows the `metadata` part of the response. If you supply a comma separated list of indices, the returned output will only contain the indices listed.
|
|
|
|
`blocks`::
|
|
Shows the `blocks` part of the response
|
|
|
|
The following example returns only `metadata` and `routing_table` data for the `foo` and `bar` indices:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET /_cluster/state/metadata,routing_table/foo,bar
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
|
|
The next example returns everything for the `foo` and `bar` indices:
|
|
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET /_cluster/state/_all/foo,bar
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
|
|
And this example return only `blocks` data:
|
|
[source,js]
|
|
--------------------------------------------------
|
|
GET /_cluster/state/blocks
|
|
--------------------------------------------------
|
|
// CONSOLE
|
|
|
|
|