You're viewing version 2.17 of the OpenSearch documentation. This version 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.
Path and HTTP methods
GET _cat/health?v
Query parameters
| Parameter | Type | Description |
|---|---|---|
| time | Time | Specify the units for time. For example, 5d or 7h. For more information, see Supported units. |
| ts | Boolean | If true, returns HH:MM:SS and Unix epoch timestamps. Default is true. |
Example request
The following example request give cluster health information for the past 5 days:
GET _cat/health?v&time=5d
Example response
GET _cat/health?v&time=5d
epoch | timestamp | cluster | status | node.total | node.data | shards | pri | relo | init | unassign | pending_tasks | max_task_wait_time | active_shards_percent
1624248112 | 04:01:52 | odfe-cluster | green | 2 | 2 | 16 | 8 | 0 | 0 | 0 | 0 | - | 100.0%