This version of the OpenSearch documentation is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

CAT health

Introduced 1.0

The CAT health operation lists the status of the cluster, how long the cluster has been up, the number of nodes, and other useful information that helps you analyze the health of your cluster.

Example

  1. GET _cat/health?v

copy

Path and HTTP methods

  1. GET _cat/health?v

copy

URL parameters

All CAT health URL parameters are optional.

ParameterTypeDescription
timeTimeSpecify the units for time. For example, 5d or 7h. For more information, see Supported units.
tsBooleanIf true, returns HH:MM:SS and Unix epoch timestamps. Default is true.

Response

  1. GET _cat/health?v&time=5d
  3. epoch | timestamp | cluster | status | node.total | node.data | shards | pri | relo | init | unassign | pending_tasks | max_task_wait_time | active_shards_percent
  4. 1624248112 | 04:01:52 | odfe-cluster | green | 2 | 2 | 16 | 8 | 0 | 0 | 0 | 0 | - | 100.0%