-
Notifications
You must be signed in to change notification settings - Fork 515
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.
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 missing wait_for_nodes param in Cluster health Reference REST API #553
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -38,14 +38,20 @@ 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<br>(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 | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Remove this line. |
||
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_status | Enum | Wait until the cluster health reaches specific status or better. Supported values are `green`, `yellow`, and `red`. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I do like the word |
||
|
||
<!-- wait_for_nodes | string | Wait until the specified number of nodes is available. Also supports operators <=, >=, <, and > | ||
# Not working properly when tested --> | ||
|
@@ -59,6 +65,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, | ||
Naarcha-AWS marked this conversation as resolved.
Show resolved
Hide resolved
|
||
"active_primary_shards" : 6, | ||
"active_shards" : 12, | ||
"relocating_shards" : 0, | ||
|
@@ -71,3 +78,9 @@ 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` | ||
{: .note } | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Let's remove the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's remove lines 41 - 44 in favor of the latest 2.0.0 change.