NOTE: You are looking at documentation for an older release. For the latest information, see the current release documentation.

› ›

cluster.allocationExplain

IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

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

`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