GET /_cluster/health
Metric | Description |
cluster_name | Cluster name |
status | Health status of the cluster, based on the state of its primary and replica shards. Statuses are: <br>– green: all shards are assigned </br>– yellow: all primary shards are assigned, but one or more replica shards are unassigned. If a node in the cluster fails, some data may be unavailable until that node is repaired </br>– 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 |
timed_out | If false , the response is returned within the period of time that is specified by the timeout parameter (30s by default) |
number_of_nodes | Number of nodes in the cluster |
number_of_data_nodes | Number of nodes that are dedicated data nodes |
active_primary_shards | Number of active primary shards |
active_shards | Total number of active primary and replica shards |
relocating_shards | Number of shards that are under relocation |
initializing_shards | Number of shards that are under initialization |
unassigned_shards | Number of unassigned shards |
delayed_unassigned_shards | Number of shards whose assignment has been delayed by the timeout settings |
number_of_pending_tasks | Number of cluster-level changes that have not yet been executed |
number_of_in_flight_fetch | Number of unfinished fetches |
task_max_waiting_in_queue_millis | Time expressed in milliseconds since the earliest initiated task is waiting for being performed |
active_shards_percent_as_number | Ratio of active shards in the cluster expressed as a percentage |
unassigned_shards
. The following is an example:GET /_cat/indices
GET /_cluster/allocation/explain
current_state
). This problem occurs because the node to which the shard was assigned left the cluster (unassigned_info.reason
).can_allocate
).allocate_explanation
).unassigned_info.reason
)allocation explain
API.Reason | Description |
INDEX_CREATED | Unassigned as a result of an API creation of an index |
CLUSTER_RECOVERED | Unassigned as a result of a full cluster recovery |
INDEX_REOPENED | Unassigned as a result of opening a closed index |
DANGLING_INDEX_IMPORTED | Unassigned as a result of importing a dangling index |
NEW_INDEX_RESTORED | Unassigned as a result of restoring into a new index |
EXISTING_INDEX_RESTORED | Unassigned as a result of restoring into a closed index |
REPLICA_ADDED | Unassigned as a result of explicit addition of a replica |
ALLOCATION_FAILED | Unassigned as a result of a failed allocation of the shard |
NODE_LEFT | Unassigned as a result of the node hosting it leaving the cluster |
REROUTE_CANCELLED | Unassigned as a result of explicit cancel reroute command |
REINITIALIZED | When a shard moves from started back to initializing |
REALLOCATED_REPLICA | A better replica location is identified and causes the existing replica allocation to be canceled |
Was this page helpful?