Link Search Menu Expand Document Documentation Menu
Documentation

You're viewing version 3.1 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Cluster State API

The /_cluster/state API retrieves the current state of the cluster, including metadata, routing tables, nodes, and other components. This API is primarily used for monitoring, debugging, and internal purposes. It provides a snapshot of various parts of the cluster’s state as maintained by the cluster manager node.

Endpoints

GET /_cluster/state
GET /_cluster/state/{metric}
GET /_cluster/state/{metric}/{target}

Path parameters

The following table lists the available path parameters. All path parameters are optional.

Parameter Data type Description
metric String or list A comma-separated list of metrics to include in the response. See Metric options for a list of available options. Default is _all.
target String or list A comma-separated list of index names, data streams, and index aliases used to limit the scope of the response.

Metric options

You can limit the information returned by the API using the metric path parameter. The following options are available:

  • _all (Default): Returns all metrics.
  • blocks: Includes information about index-level and global blocks.
  • metadata: Returns cluster metadata, including settings, index mappings, and templates.
  • nodes: Returns information about the nodes in the cluster.
  • routing_table: Provides the routing information for all shards.
  • cluster_manager_node: Displays the ID of the currently elected cluster manager node.
  • version: Displays the current cluster state version.

Query parameters

The following table lists the available query parameters. All query parameters are optional.

Parameter Data type Description
local Boolean If true, retrieves the state from the local node instead of the cluster manager node. Default is false.
cluster_manager_timeout Time The timeout duration for connecting to the cluster manager node. Default is 30s.
flat_settings Boolean If true, returns settings in a flat format. Default is false.
wait_for_metadata_version Integer Waits until the metadata version is equal to or greater than this value before responding.
wait_for_timeout Time Specifies how long to wait when using wait_for_metadata_version. Default is 30s.
ignore_unavailable Boolean Whether to ignore missing or closed indexes. Default is false.
expand_wildcards String Specifies the type of index that wildcard expressions can match. Supports comma-separated values.
Valid values are:
- all: Match any index, including hidden ones.
- closed: Match closed, non-hidden indexes.
- hidden: Match hidden indexes. Must be combined with open, closed, or both.
- none: Wildcard expressions are not accepted.
- open: Match open, non-hidden indexes.
Default is open.
allow_no_indices Boolean Whether to fail if a wildcard expression or index alias resolves to no indexes. Default is true.

Example

Retrieve the full cluster state:

GET /_cluster/state

Retrieve metadata and the routing table for a specific index:

GET /_cluster/state/metadata,routing_table/my-index

Retrieve only the currently elected cluster manager node:

GET /_cluster/state/cluster_manager_node

Response fields

The following table lists all response fields.

Field Data type Description
cluster_name String The name of the cluster.
cluster_uuid String The unique identifier for the cluster.
version Integer The current version of the cluster state.
state_uuid String The unique identifier for this version of the state.
master_node String As with cluster_manager_node, this is maintained for backward compatibility.
cluster_manager_node String The node ID of the elected cluster manager node.
blocks Object Index-level block settings.
metadata Object Index mappings, settings, and aliases.
nodes Object Details of all nodes in the cluster.
routing_table Object Shard-to-node allocation per index.
routing_nodes Object Lists of shards assigned to each node.
indices Object Index-specific state metadata.
350 characters left

Have a question? .

Want to contribute? or .