Get the cluster state
- GET /_cluster/state/{metric}/{index}
- GET /_cluster/state/{metric}
- GET /_cluster/state
Get comprehensive information about the state of the cluster.
The cluster state is an internal data structure which keeps track of a variety of information needed by every node, including the identity and attributes of the other nodes in the cluster; cluster-wide settings; index metadata, including the mapping and settings for each index; the location and status of every shard copy in the cluster.
The elected master node ensures that every node in the cluster has a copy of the same cluster state. This API lets you retrieve a representation of this internal state for debugging or diagnostic purposes. You may need to consult the Elasticsearch source code to determine the precise meaning of the response.
By default the API will route requests to the elected master node since this node is the authoritative source of cluster states.
You can also retrieve the cluster state held on the node handling the API request by adding the ?local=true query parameter.
Elasticsearch may need to expend significant effort to compute a response to this API in larger clusters, and the response may comprise a very large quantity of data. If you use this API repeatedly, your cluster may become unstable.
WARNING: The response is a representation of an internal data structure. Its format is not subject to the same compatibility guarantees as other more stable APIs and may change from version to version. Do not query this API using external monitoring tools. Instead, obtain the information you require using other more stable cluster APIs.
- Cluster privileges:
monitor,manage
Path Parameters
-
metricClusterStateMetric | ClusterStateMetricoptional -
Limit the information returned to the specified metrics.
Supported values include:
_all: Shows all metrics.version: Shows the cluster state version.master_node: Shows the electedmaster_nodepart of the response.blocks: Shows theblockspart of the response.nodes: Shows thenodespart of the response.metadata: Shows themetadatapart of the response. If you supply a comma-separated list of indices, the returned output will only contain metadata for these indices.routing_table: Shows therouting_tablepart of the response. If you supply a comma-separated list of indices, the returned output will only contain the routing table for these indices.routing_nodes: Shows therouting_nodespart of the response.customs: Shows thecustomspart of the response, which includes custom cluster state information.
Leave it out to use
/_cluster/state. -
Values:
_allversionmaster_nodeblocksnodesmetadatarouting_tablerouting_nodescustoms -
indexIndexName | IndexNameoptional -
A comma-separated list of index names; use
_allor empty string to perform the operation on all indicesLeave it out to use
/_cluster/state.
Query Parameters
-
allow_no_indicesboolean · default: true A setting that does two separate checks on the index expression. If
false, the request returns an error (1) if any wildcard expression (including_alland*) resolves to zero matching indices or (2) if the complete set of resolved indices, aliases or data streams is empty after all expressions are evaluated. Iftrue, index expressions that resolve to no indices are allowed and the request returns an empty result.-
expand_wildcardsstring ExpandWildcards · default: open Whether to expand wildcard expression to concrete indices that are open, closed or both
Supported values include:
all: Match any data stream or index, including hidden ones.open: Match open, non-hidden indices. Also matches any non-hidden data stream.closed: Match closed, non-hidden indices. Also matches any non-hidden data stream. Data streams cannot be closed.hidden: Match hidden data streams and hidden indices. Must be combined withopen,closed, orboth.none: Wildcard expressions are not accepted.
-
Values:
allopenclosedhiddennone -
flat_settingsboolean · default: false Return settings in flat format
If
false, the request returns an error if it targets a concrete (non-wildcarded) index, alias, or data stream that is missing, closed, or otherwise unavailable. Iftrue, unavailable concrete targets are silently ignored.-
localboolean · default: falsedeprecated Return local information, do not retrieve the state from master node
-
master_timeoutstring Duration · default: 30s Timeout for waiting for new cluster state in case it is blocked
-
wait_for_metadata_versionnumber VersionNumber Wait for the metadata version to be equal or greater than the specified metadata version
-
wait_for_timeoutstring Duration The maximum time to wait for wait_for_metadata_version before timing out
Response
Response Type: object