delete-desired-balance.asciidoc 1.3 KB

123456789101112131415161718192021222324252627282930
  1. [[delete-desired-balance]]
  2. === Reset desired balance API
  3. ++++
  4. <titleabbrev>Reset desired balance</titleabbrev>
  5. ++++
  6. NOTE: {cloud-only}
  7. .New API reference
  8. [sidebar]
  9. --
  10. For the most up-to-date API details, refer to {api-es}/group/endpoint-cluster[Cluster APIs].
  11. --
  12. Discards the current <<shards-rebalancing-heuristics,desired balance>> and computes a new desired balance starting from the current allocation of shards.
  13. This can sometimes help {es} find a desired balance which needs fewer shard movements to achieve, especially if the
  14. cluster has experienced changes so substantial that the current desired balance is no longer optimal without {es} having
  15. detected that the current desired balance will take more shard movements to achieve than needed. However, this API
  16. imposes a heavy load on the elected master node and may not always have the expected effect. Calling this API should
  17. never be necessary. Consider instead <<shards-rebalancing-heuristics,increasing the value of
  18. `cluster.routing.allocation.balance.threshold`>> to avoid excessive shard movements.
  19. [[delete-desired-balance-request]]
  20. ==== {api-request-title}
  21. [source,console]
  22. --------------------------------------------------
  23. DELETE /_internal/desired_balance
  24. --------------------------------------------------
  25. // TEST[skip:Can't reliably test desired balance]