IMPORTANT: elasticsearch.js has been replaced by the new Elasticsearch JavaScript client. We strongly advise you to migrate to the new client. To learn more, see the migration guide.

« cluster.reroute cluster.stats »
Elastic Docs ›elasticsearch.js ›7.5 API

cluster.state

edit

cluster.state

edit
client.cluster.state([params, [callback]])

Get comprehensive details about the state of the whole cluster (indices settings, allocations, etc).

Check the API Conventions and the elasticsearch docs for more information pertaining to this method.

Params

local

Boolean — Return local information, do not retrieve the state from master node (default: false)

masterTimeout

DurationString — Specify timeout for connection to master

flatSettings

Boolean — Return settings in flat format (default: false)

waitForMetadataVersion

Number — Wait for the metadata version to be equal or greater than the specified metadata version

waitForTimeout

DurationString — The maximum time to wait for wait_for_metadata_version before timing out

ignoreUnavailable

Boolean — Whether specified concrete indices should be ignored when unavailable (missing or closed)

allowNoIndices

Boolean — Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes _all string or when no indices have been specified)

[expandWildcards=open]

String — Whether to expand wildcard expression to concrete indices that are open, closed or both.

Options
  • "open"
  • "closed"
  • "none"
  • "all"

index

String, String[], Boolean — A comma-separated list of index names; use _all or empty string to perform the operation on all indices

metric

String, String[], Boolean — Limit the information returned to the specified metrics

back to top

« cluster.reroute cluster.stats »