@@ -11,7 +11,9 @@ Adds or removes master-eligible nodes from the
11
11
[[voting-config-exclusions-api-request]]
12
12
==== {api-request-title}
13
13
14
- `POST _cluster/voting_config_exclusions/<node_name>` +
14
+ `POST _cluster/voting_config_exclusions?node_names=<node_names>` +
15
+
16
+ `POST _cluster/voting_config_exclusions?node_ids=<node_ids>` +
15
17
16
18
`DELETE _cluster/voting_config_exclusions`
17
19
@@ -42,39 +44,43 @@ master-eligible nodes.
42
44
43
45
For more information, see <<modules-discovery-removing-nodes>>.
44
46
45
-
46
- [[voting-config-exclusions-api-path-params]]
47
- ==== {api-path-parms-title}
48
-
49
- `<node_name>`::
50
- A <<cluster-nodes,node filter>> that identifies {es} nodes.
51
-
52
-
53
47
[[voting-config-exclusions-api-query-params]]
54
48
==== {api-query-parms-title}
55
49
56
- `cluster.auto_shrink_voting_configuration`::
57
- (Optional, boolean) If `false`, you must use this API to maintain the voting
58
- configuration. Defaults to `true`.
59
-
60
- `cluster.max_voting_config_exclusions`::
61
- (Optional, integer) Limits the size of the voting configuration exclusion
62
- list. The default value is `10`. Since voting configuration exclusions are
63
- persistent and limited in number, you must clear the voting config
64
- exclusions list once the exclusions are no longer required.
65
-
50
+ `node_names`::
51
+ A comma-separated list of the names of the nodes to exclude from the voting
52
+ configuration. If specified, you may not also specify `?node_ids`.
53
+
54
+ `node_ids`::
55
+ A comma-separated list of the persistent ids of the nodes to exclude from the
56
+ voting configuration. If specified, you may not also specify `?node_names`.
57
+
58
+ `timeout`::
59
+ (Optional, <<time-units, time units>>) When adding a voting configuration
60
+ exclusion, the API waits for the specified nodes to be excluded from the voting
61
+ configuration before returning. The period of time to wait is specified by the
62
+ `?timeout` query parameter. If the timeout expires before the appropriate
63
+ condition is satisfied, the request fails and returns an error. Defaults to
64
+ `30s`.
65
+
66
+ `wait_for_removal`::
67
+ (Optional, boolean) Specifies whether to wait for all excluded nodes to be
68
+ removed from the cluster before clearing the voting configuration exclusions
69
+ list. Defaults to `true`, meaning that all excluded nodes must be removed from
70
+ the cluster before this API takes any action. If set to `false` then the voting
71
+ configuration exclusions list is cleared even if some excluded nodes are still
72
+ in the cluster.
66
73
67
74
[[voting-config-exclusions-api-example]]
68
75
==== {api-examples-title}
69
76
70
- Add `nodeId1` to the voting configuration exclusions list:
77
+ Adds nodes named `nodeName1` and `nodeName2` to the voting configuration
78
+ exclusions list:
71
79
72
80
[source,console]
73
81
--------------------------------------------------
74
- POST /_cluster/voting_config_exclusions/nodeId1
82
+ POST /_cluster/voting_config_exclusions?node_names=nodeName1,nodeName2
75
83
--------------------------------------------------
76
- // TEST[catch:bad_request]
77
-
78
84
79
85
Remove all exclusions from the list:
80
86
0 commit comments