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.
Endpoints
GET /_cat/health
Query parameters
The following table lists the available query parameters. All query parameters are optional.
| Parameter | Data type | Description | Default |
|---|---|---|---|
format | String | A short version of the Accept header, such as json or yaml. | N/A |
h | List | A comma-separated list of column names to display. | N/A |
help | Boolean | Returns help information. | false |
s | List | A comma-separated list of column names or column aliases to sort by. | N/A |
time | String | The unit used to display time values. Valid values are: nanos, micros, ms, s, m, h, d | N/A |
ts | Boolean | When true, returns HH:MM:SS and Unix epoch timestamps. | true |
v | Boolean | Enables verbose mode, which displays column headers. | false |
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%