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

• expand_wildcards
  string | array[string]
  Whether to expand wildcard expression to concrete indices that are open, closed or both.
  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.
• wait_for_active_shards
  number | string
  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.
• wait_for_nodes
  string | number
  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.
• wait_for_no_initializing_shards
  boolean
  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.
• wait_for_no_relocating_shards
  boolean
  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.
  Values are green, GREEN, yellow, YELLOW, red, or RED.

Responses

• 200 application/json
  Hide response attributes Show response attributes object
  • active_primary_shards
    number Required
    The number of active primary shards.
  • active_shards
    number Required
    The total number of active primary and replica shards.
  • active_shards_percent
    string
    The ratio of active shards in the cluster expressed as a string formatted percentage.
  • active_shards_percent_as_number
    number Required
    The ratio of active shards in the cluster expressed as a percentage.
  • cluster_name
    string Required
  • delayed_unassigned_shards
    number Required
    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
    * active_primary_shards
    number Required
    * active_shards
    number Required
    * initializing_shards
    number Required
    * number_of_replicas
    number Required
    * number_of_shards
    number Required
    * relocating_shards
    number Required
    * Hide shards attribute Show shards attribute object
    * *
    object Additional properties
    Hide * attributes Show * attributes object
    * active_shards
    number Required
    * initializing_shards
    number Required
    * primary_active
    boolean Required
    * relocating_shards
    number Required
    * Values are green, GREEN, yellow, YELLOW, red, or RED.
    * unassigned_shards
    number Required
    * unassigned_primary_shards
    number Required
    * Values are green, GREEN, yellow, YELLOW, red, or RED.
    * unassigned_shards
    number Required
    * unassigned_primary_shards
    number Required
  • initializing_shards
    number Required
    The number of shards that are under initialization.
  • number_of_data_nodes
    number Required
    The number of nodes that are dedicated data nodes.
  • number_of_in_flight_fetch
    number Required
    The number of unfinished fetches.
  • number_of_nodes
    number Required
    The number of nodes within the cluster.
  • number_of_pending_tasks
    number Required
    The number of cluster-level changes that have not yet been executed.
  • relocating_shards
    number Required
    The number of shards that are under relocation.
  • Values are green, GREEN, yellow, YELLOW, red, or RED.
  • task_max_waiting_in_queue
    string
    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.
  • task_max_waiting_in_queue_millis
    number
    Time unit for milliseconds
  • timed_out
    boolean Required
    If false the response returned within the period of time that is specified by the timeout parameter (30s by default)
  • unassigned_primary_shards
    number Required
    The number of primary shards that are not allocated.
  • unassigned_shards
    number Required
    The number of shards that are not allocated.