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.getSettings cluster.pendingTasks »
Elastic Docs ›elasticsearch.js ›7.5 API

cluster.health

edit

cluster.health

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

Get a very simple status on the health of the cluster.

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

Params

[expandWildcards=all]

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

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

[level=cluster]

String — Specify the level of detail for returned information

Options
  • "cluster"
  • "indices"
  • "shards"

local

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

masterTimeout

DurationString — Explicit operation timeout for connection to master node

timeout

DurationString — Explicit operation timeout

waitForActiveShards

String — Wait until the specified number of shards is active

waitForNodes

String — Wait until the specified number of nodes is available

waitForEvents

String — Wait until all currently queued events with the given priority are processed

Options
  • "immediate"
  • "urgent"
  • "high"
  • "normal"
  • "low"
  • "languid"

waitForNoRelocatingShards

Boolean — Whether to wait until there are no relocating shards in the cluster

waitForNoInitializingShards

Boolean — Whether to wait until there are no initializing shards in the cluster

waitForStatus

String — Wait until cluster is in a specific state

Options
  • "green"
  • "yellow"
  • "red"

index

String, String[], Boolean — Limit the information returned to a specific index

back to top

« cluster.getSettings cluster.pendingTasks »