Get the cluster health status | Elasticsearch API documentation (original) (raw)

Dismiss highlight Show more

Path parameters

• index
  string | array[string] Required
  Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. To target all data streams and indices in a cluster, omit this parameter or use _all or *.

Query parameters

• 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 with open, closed, or both.
  • none: Wildcard expressions are not accepted.
    Values are all, open, closed, hidden, or none.
• Can be one of cluster, indices or shards. Controls the details level of the health information returned.
  Values are cluster, indices, or shards.
• If true, the request retrieves information from the local node only. Defaults to false, which means information is retrieved from the master node.
• Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
• Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
• A number controlling to how many active shards to wait for, all to wait for all shards in the cluster to be active, or 0 to not wait.
  Values are all or index-setting.
• Can be one of immediate, urgent, high, normal, low, languid. Wait until all currently queued events with the given priority are processed.
  Values are immediate, urgent, high, normal, low, or languid.
• The request waits until the specified number N of nodes is available. It also accepts >=N, <=N, >N and <N. Alternatively, it is possible to use ge(N), le(N), gt(N) and lt(N) notation.
• A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard initializations. Defaults to false, which means it will not wait for initializing shards.
• A boolean value which controls whether to wait (until the timeout provided) for the cluster to have no shard relocations. Defaults to false, which means it will not wait for relocating shards.
• One of green, yellow or red. Will wait (until the timeout provided) until the status of the cluster changes to the one provided or better, i.e. green > yellow > red. By default, will not wait for any status.
  Supported values include:
  • green (or GREEN): All shards are assigned.
  • yellow (or YELLOW): All primary shards are assigned, but one or more replica shards are unassigned. If a node in the cluster fails, some data could be unavailable until that node is repaired.
  • red (or RED): One or more primary shards are unassigned, so some data is unavailable. This can occur briefly during cluster startup as primary shards are assigned.
    Values are green, GREEN, yellow, YELLOW, red, or RED.

Responses

• 200 application/json
  Hide response attributes Show response attributes object
  • The number of active primary shards.
  • The total number of active primary and replica shards.
  • The ratio of active shards in the cluster expressed as a string formatted percentage.
  • The ratio of active shards in the cluster expressed as a percentage.
  • The number of shards whose allocation has been delayed by the timeout settings.
  • Hide indices attribute Show indices attribute object
    * *
    object Additional properties
    Hide * attributes Show * attributes object
    * Hide shards attribute Show shards attribute object
    * *
    object Additional properties
    Hide * attributes Show * attributes object
    * Values are green, GREEN, yellow, YELLOW, red, or RED.
    * Values are green, GREEN, yellow, YELLOW, red, or RED.
  • The number of shards that are under initialization.
  • The number of nodes that are dedicated data nodes.
  • The number of unfinished fetches.
  • The number of nodes within the cluster.
  • The number of cluster-level changes that have not yet been executed.
  • The number of shards that are under relocation.
  • Values are green, GREEN, yellow, YELLOW, red, or RED.
  • A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  • Time unit for milliseconds
  • If false the response returned within the period of time that is specified by the timeout parameter (30s by default)
  • The number of primary shards that are not allocated.
  • The number of shards that are not allocated.