Skip to content

Commit 69b4617

Browse files
committed
Clarify status of response to voting config API (#115714)
These APIs return no body, just a status code. This commit clarifies that in the docs. Closes #115462
1 parent 5cccabe commit 69b4617

File tree

1 file changed

+13
-9
lines changed

1 file changed

+13
-9
lines changed

docs/reference/cluster/voting-exclusions.asciidoc

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77
Adds or removes master-eligible nodes from the
88
<<modules-discovery-voting,voting configuration exclusion list>>.
99

10-
1110
[[voting-config-exclusions-api-request]]
1211
==== {api-request-title}
1312

@@ -28,7 +27,7 @@ users can use this API.
2827

2928
[[voting-config-exclusions-api-desc]]
3029
==== {api-description-title}
31-
30+
3231
By default, if there are more than three master-eligible nodes in the cluster
3332
and you remove fewer than half of the master-eligible nodes in the cluster at
3433
once, the <<modules-discovery-voting,voting configuration>> automatically
@@ -50,14 +49,19 @@ use `DELETE /_cluster/voting_config_exclusions?wait_for_removal=false` to clear
5049
the voting configuration exclusions without waiting for the nodes to leave the
5150
cluster.
5251

53-
If the API fails, you can safely retry it. Only a successful response
54-
guarantees that the node has been removed from the voting configuration and
55-
will not be reinstated.
52+
A response to `POST /_cluster/voting_config_exclusions` with an HTTP status
53+
code of `200 OK` guarantees that the node has been removed from the voting
54+
configuration and will not be reinstated until the voting configuration
55+
exclusions are cleared by calling `DELETE /_cluster/voting_config_exclusions`.
56+
If the call to `POST /_cluster/voting_config_exclusions` fails or returns a
57+
response with an HTTP status code other than `200 OK` then the node may not
58+
have been removed from the voting configuration. In that case, you may safely
59+
retry the call.
5660

5761
NOTE: Voting exclusions are required only when you remove at least half of the
5862
master-eligible nodes from a cluster in a short time period. They are not
59-
required when removing master-ineligible nodes or fewer than half of the
60-
master-eligible nodes.
63+
required when removing master-ineligible nodes or when removing fewer than half
64+
of the master-eligible nodes.
6165

6266
For more information, see <<modules-discovery-removing-nodes>>.
6367

@@ -94,15 +98,15 @@ list. Defaults to `true`, meaning that all excluded nodes must be removed from
9498
the cluster before this API takes any action. If set to `false` then the voting
9599
configuration exclusions list is cleared even if some excluded nodes are still
96100
in the cluster. Only applies to the `DELETE` form of this API.
97-
101+
98102
[[voting-config-exclusions-api-example]]
99103
==== {api-examples-title}
100104

101105
Adds nodes named `nodeName1` and `nodeName2` to the voting configuration
102106
exclusions list:
103107

104108
[source,console]
105-
--------------------------------------------------
109+
--------------------------------------------------
106110
POST /_cluster/voting_config_exclusions?node_names=nodeName1,nodeName2
107111
--------------------------------------------------
108112

0 commit comments

Comments
 (0)