iSharkFly-Docs
/
opensearch-docs-cn
mirror of https://github.com/iSharkFly-Docs/opensearch-docs-cn
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #599 from opensearch-project/lukas-vlcek-improve_cluster_health 

Add wait for node param to Cluster Health
This commit is contained in:
Naarcha-AWS 2022-05-23 14:29:31 -05:00 committed by GitHub
parent 5ca9327c97 9585132bd9
commit 18c6e9cdbb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
_opensearch/rest-api/cluster-health.md
View File

@ -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
@ -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,
@ -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`.