elasticsearch/docs/reference/cluster/delete-desired-balance.asciidoc
David Turner 7ee63dfd51
Expand docs on reset desired balance API (#106921)
Explains its purpose and surrounding context a little more, including a
note that this should never be necessary (i.e. if you find you need it,
that's a bug).
2024-04-02 04:18:59 -04:00

24 lines
1.1 KiB
Text

[[delete-desired-balance]]
=== Reset desired balance API
++++
<titleabbrev>Reset desired balance</titleabbrev>
++++
NOTE: {cloud-only}
Discards the current desired balance and computes a new desired balance starting from the current allocation of shards.
This can sometimes help {es} find a desired balance which needs fewer shard movements to achieve, especially if the
cluster has experienced changes so substantial that the current desired balance is no longer optimal without {es} having
detected that the current desired balance will take more shard movements to achieve than needed. However, this API
imposes a heavy load on the elected master node and may not always have the expected effect. Calling this API should
never be necessary. Consider instead <<shards-rebalancing-heuristics,increasing the value of
`cluster.routing.allocation.balance.threshold`>> to avoid excessive shard movements.
[[delete-desired-balance-request]]
==== {api-request-title}
[source,console]
--------------------------------------------------
DELETE /_internal/desired_balance
--------------------------------------------------
// TEST[skip:Can't reliably test desired balance]