WARNING: Version 5.x has passed its EOL date.

This documentation is no longer being maintained and may be removed. If you are running this version, we strongly advise you to upgrade. For the latest information, see the current release documentation.

Elastic Docs ›Elasticsearch Node.js client [5.x] ›API Reference
« clearScroll cluster.getSettings »

cluster.allocationExplainedit

client.cluster.allocationExplain({
  include_yes_decisions: boolean,
  include_disk_info: boolean,
  body: object
})

Reference

include_yes_decisions or includeYesDecisions

boolean - Return YES decisions in explanation (default: false)

include_disk_info or includeDiskInfo

boolean - Return information about disk usage and shard sizes (default: false)

body

object - The index, shard, and primary flag to explain. Empty means explain the first unassigned shard
« clearScroll cluster.getSettings »