From 9585132bd90caa760e641ec6da5a8e6c5915a194 Mon Sep 17 00:00:00 2001 From: Naarcha-AWS Date: Mon, 23 May 2022 12:53:37 -0500 Subject: [PATCH] Add wait_for_node parameter to cluster health Signed-off-by: Naarcha-AWS --- _opensearch/rest-api/cluster-health.md | 13 ++----------- 1 file changed, 2 insertions(+), 11 deletions(-) diff --git a/_opensearch/rest-api/cluster-health.md b/_opensearch/rest-api/cluster-health.md index cb636023..c9729a8c 100644 --- a/_opensearch/rest-api/cluster-health.md +++ b/_opensearch/rest-api/cluster-health.md @@ -38,23 +38,15 @@ Parameter | Type | Description :--- | :--- | :--- expand_wildcards | Enum | Expands wildcard expressions to concrete indexes. Combine multiple values with commas. Supported values are `all`, `open`, `closed`, `hidden`, and `none`. Default is `open`. level | Enum | The level of detail for returned health information. Supported values are `cluster`, `indices`, and `shards`. Default is `cluster`. -<<<<<<< improve_cluster_health -local | Boolean | Whether to return information from the local node only instead of from the master node. Default is false. -cluster_manager_timeout
(deprecated `master_timeout`) | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds. -======= local | Boolean | Whether to return information from the local node only instead of from the cluster manager node. Default is false. cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds. ->>>>>>> main 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 health reaches specific status or better. Supported values are `green`, `yellow`, and `red`. - - +wait_for_status | Enum | Wait until the cluster health reaches the specified status or better. Supported values are `green`, `yellow`, and `red`. ## Response @@ -82,5 +74,4 @@ wait_for_status | Enum | Wait until the cluster health reaches specific status o ## Required permissions If you use the security plugin, make sure you have the appropriate permissions: -`cluster:monitor/health` -{: .note } \ No newline at end of file +`cluster:monitor/health`. \ No newline at end of file