Cluster health

Cluster health #

Returns the cluster health for quick overview.

Get the whole cluster health #

Requests #

GET /_cluster/health

The call is bounded by a 10s timeout; when the cluster cannot answer in time it returns HTTP 503 with "status": "timeout", "timeout": true and points at /_node/_local/recovery for details — treat that as “degraded, still converging” when polling for readiness.

Query Parameters #

• level
  (Optional, string) Can be one of cluster, regions, collections rollings or shards. Controls the details level of the health information returned. Defaults to cluster.

Get the health of a specific region #

Requests #

GET /_cluster/_region/<region_id>/health

Path parameters #

• region_id
  (Required, String) The region to query. Currently only the special ID _local — the region that handles this request — is implemented; a remote region UUID answers 501 not implemented yet.

Query Parameters #

• level
  (Optional, string) Can be one of regions, collections rollings or shards. Controls the details level of the health information returned. Defaults to regions.