MUHAMMAD SAMIULLAHandNaarcha-AWS
84e4ab158e
* Fix APIs File Signed-off-by: samipak458 <[email protected]> * Update API files according to API template Signed-off-by: samipak458 <[email protected]> * Update exec-stored-script.md Signed-off-by: Naarcha-AWS <[email protected]> * Update cat-aliases.md Signed-off-by: MUHAMMAD SAMIULLAH <[email protected]> * Update cat-allocation.md Signed-off-by: MUHAMMAD SAMIULLAH <[email protected]> * Update cat-cluster_manager.md Signed-off-by: MUHAMMAD SAMIULLAH <[email protected]> * Update cat-count.md Signed-off-by: MUHAMMAD SAMIULLAH <[email protected]> * Update cat-field-data.md Signed-off-by: MUHAMMAD SAMIULLAH <[email protected]> * Update cat-health.md Signed-off-by: MUHAMMAD SAMIULLAH <[email protected]> * updated * updated * updated --------- Signed-off-by: samipak458 <[email protected]> Signed-off-by: Naarcha-AWS <[email protected]> Signed-off-by: MUHAMMAD SAMIULLAH <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]>
1.2 KiB
1.2 KiB
layout, title, parent, nav_order, has_children, redirect_from
| layout | title | parent | nav_order | has_children | redirect_from | |
|---|---|---|---|---|---|---|
| default | CAT health | CAT API | 20 | false |
|
CAT health
Introduced 1.0 {: .label .label-purple }
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
GET _cat/health?v
{% include copy-curl.html %}
Path and HTTP methods
GET _cat/health?v
{% include copy-curl.html %}
URL parameters
All CAT health URL parameters are optional.
| 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. |
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%