Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add wait for node param to Cluster Health #599

Merged
merged 4 commits into from
May 23, 2022
Merged

Add wait for node param to Cluster Health #599

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9cbdc64
Document missing wait_for_nodes param in Cluster health Reference RES…
lukas-vlcek May 4, 2022
46d7a45
Merge branch 'main' into improve_cluster_health
Naarcha-AWS May 18, 2022
219c1c3
Merge branch 'improve_cluster_health' of https://github.com/lukas-vlc…
Naarcha-AWS May 23, 2022
9585132
Add wait_for_node parameter to cluster health
Naarcha-AWS May 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 8 additions & 4 deletions _opensearch/rest-api/cluster-health.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,11 @@ local | Boolean | Whether to return information from the local node only instead
cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.
timeout | Time | The amount of time to wait for a response. If the timeout expires, the request fails. Default is 30 seconds.
wait_for_active_shards | String | Wait until the specified number of shards is active before returning a response. `all` for all shards. Default is `0`.
wait_for_nodes | String | Wait for N number of nodes. Use `12` for exact match, `>12` and `<12` for range.
wait_for_events | Enum | Wait until all currently queued events with the given priority are processed. Supported values are `immediate`, `urgent`, `high`, `normal`, `low`, and `languid`.
wait_for_no_relocating_shards | Boolean | Whether to wait until there are no relocating shards in the cluster. Default is false.
wait_for_no_initializing_shards | Boolean | Whether to wait until there are no initializing shards in the cluster. Default is false.
wait_for_status | Enum | Wait until the cluster is in a specific state or better. Supported values are `green`, `yellow`, and `red`.

<!-- wait_for_nodes | string | Wait until the specified number of nodes is available. Also supports operators <=, >=, <, and >
# Not working properly when tested -->
wait_for_status | Enum | Wait until the cluster health reaches the specified status or better. Supported values are `green`, `yellow`, and `red`.

## Response

Expand All @@ -59,6 +57,7 @@ wait_for_status | Enum | Wait until the cluster is in a specific state or better
"timed_out" : false,
"number_of_nodes" : 2,
"number_of_data_nodes" : 2,
"discovered_master" : true,
"active_primary_shards" : 6,
"active_shards" : 12,
"relocating_shards" : 0,
Expand All @@ -71,3 +70,8 @@ wait_for_status | Enum | Wait until the cluster is in a specific state or better
"active_shards_percent_as_number" : 100.0
}
```

## Required permissions

If you use the security plugin, make sure you have the appropriate permissions:
`cluster:monitor/health`.