Get the cluster state

GET /_cluster/state/{metric}/{index}

Copy endpoint

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.

Required authorization

Cluster privileges: monitor,manage

Parameters

path Path Parameters

Name	Type
`metric` required Limit the information returned to the specified metrics.	type ClusterStateClusterStateMetrics = type ClusterStateClusterStateMetric = "_all" \| "version" \| "master_node" \| "blocks" \| "nodes" \| "metadata" \| "routing_table" \| "routing_nodes" \| "customs" \| type ClusterStateClusterStateMetric = "_all" \| "version" \| "master_node" \| "blocks" \| "nodes" \| "metadata" \| "routing_table" \| "routing_nodes" \| "customs"[]
`index` required A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices	type TypesIndices = type TypesIndexName = string \| type TypesIndexName = string[]

query Query Parameters

Name	Type
`allow_no_indices` Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)	boolean
`expand_wildcards` Whether to expand wildcard expression to concrete indices that are open, closed or both	type TypesExpandWildcards = type TypesExpandWildcard = "all" \| "open" \| "closed" \| "hidden" \| "none" \| type TypesExpandWildcard = "all" \| "open" \| "closed" \| "hidden" \| "none"[]
`flat_settings` Return settings in flat format	boolean
`ignore_unavailable` Whether specified concrete indices should be ignored when unavailable (missing or closed)	boolean
`local` deprecated Return local information, do not retrieve the state from master node	boolean
`master_timeout` Timeout for waiting for new cluster state in case it is blocked	type TypesDuration = string \| "-1" \| "0"
`wait_for_metadata_version` Wait for the metadata version to be equal or greater than the specified metadata version	type TypesVersionNumber = number
`wait_for_timeout` The maximum time to wait for wait_for_metadata_version before timing out	type TypesDuration = string \| "-1" \| "0"

Responses

200 application/json

{}