7
7
Adds or removes master-eligible nodes from the
8
8
<<modules-discovery-voting,voting configuration exclusion list>>.
9
9
10
- [float]
11
- ==== Request
12
10
13
- `POST _cluster/voting_config_exclusions/<node_name>` +
11
+ [[voting-config-exclusions-api-request]]
12
+ ==== {api-request-title}
14
13
15
- `DELETE _cluster/voting_config_exclusions`
14
+ `POST _cluster/voting_config_exclusions/{node_name}` +
16
15
17
- [float]
18
- ==== Path parameters
16
+ `DELETE _cluster/voting_config_exclusions`
19
17
20
- `node_name`::
21
- A <<cluster-nodes,node filter>> that identifies {es} nodes.
22
18
23
- [float ]
24
- ==== Description
19
+ [[voting-config-exclusions-api-desc] ]
20
+ ==== {api-description-title}
25
21
26
22
By default, if there are more than three master-eligible nodes in the cluster
27
23
and you remove fewer than half of the master-eligible nodes in the cluster at
@@ -44,31 +40,45 @@ master-eligible nodes from a cluster in a short time period. They are not
44
40
required when removing master-ineligible nodes or fewer than half of the
45
41
master-eligible nodes.
46
42
47
- The <<modules-discovery-settings,`cluster.max_voting_config_exclusions`
48
- setting>> limits the size of the voting configuration exclusion list. The
49
- default value is `10`. Since voting configuration exclusions are persistent and
50
- limited in number, you must clear the voting config exclusions list once the
51
- exclusions are no longer required.
43
+ For more information, see <<modules-discovery-removing-nodes>>.
44
+
52
45
53
- There is also a
54
- <<modules-discovery-settings,`cluster.auto_shrink_voting_configuration` setting>>,
55
- which is set to true by default. If it is set to false, you must use this API to
56
- maintain the voting configuration.
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.
57
51
58
- For more information, see <<modules-discovery-removing-nodes>>.
59
52
60
- [float]
61
- ==== Examples
53
+ [[voting-config-exclusions-api-query-params]]
54
+ ==== {api-query-parms-title}
55
+
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
+
66
+
67
+ [[voting-config-exclusions-api-example]]
68
+ ==== {api-examples-title}
62
69
63
70
Add `nodeId1` to the voting configuration exclusions list:
71
+
64
72
[source,js]
65
73
--------------------------------------------------
66
74
POST /_cluster/voting_config_exclusions/nodeId1
67
75
--------------------------------------------------
68
76
// CONSOLE
69
77
// TEST[catch:bad_request]
70
78
79
+
71
80
Remove all exclusions from the list:
81
+
72
82
[source,js]
73
83
--------------------------------------------------
74
84
DELETE /_cluster/voting_config_exclusions
0 commit comments