Voting configuration exclusions APIedit

Adds or removes master-eligible nodes from the voting configuration exclusion list.

Requestedit

POST _cluster/voting_config_exclusions/<node_name>

DELETE _cluster/voting_config_exclusions

Descriptionedit

By default, if there are more than three master-eligible nodes in the cluster and you remove fewer than half of the master-eligible nodes in the cluster at once, the voting configuration automatically shrinks.

If you want to shrink the voting configuration to contain fewer than three nodes or to remove half or more of the master-eligible nodes in the cluster at once, you must use this API to remove departed nodes from the voting configuration manually. It adds an entry for that node in the voting configuration exclusions list. The cluster then tries to reconfigure the voting configuration to remove that node and to prevent it from returning.

If the API fails, you can safely retry it. Only a successful response guarantees that the node has been removed from the voting configuration and will not be reinstated.

Note

Voting exclusions are required only when you remove at least half of the master-eligible nodes from a cluster in a short time period. They are not required when removing master-ineligible nodes or fewer than half of the master-eligible nodes.

For more information, see Removing master-eligible nodes.

Path parametersedit

<node_name>
A node filter that identifies Elasticsearch nodes.

Query parametersedit

cluster.auto_shrink_voting_configuration
(Optional, boolean) If false, you must use this API to maintain the voting configuration. Defaults to true.
cluster.max_voting_config_exclusions
(Optional, integer) Limits the size of the voting configuration exclusion list. The default value is 10. Since voting configuration exclusions are persistent and limited in number, you must clear the voting config exclusions list once the exclusions are no longer required.

Examplesedit

Add nodeId1 to the voting configuration exclusions list:

POST /_cluster/voting_config_exclusions/nodeId1

Remove all exclusions from the list:

DELETE /_cluster/voting_config_exclusions