IMPORTANT: elasticsearch.js has been replaced by the new Elasticsearch JavaScript client. We strongly advise you to migrate to the new client. To learn more, see the migration guide.

« cat.threadPool cluster.getSettings »

› ›

cluster.allocationExplain

edit

`cluster.allocationExplain`

edit

client.cluster.allocationExplain([params, [callback]])

Check the API Conventions and the elasticsearch docs for more information pertaining to this method.

Params

`includeYesDecisions`	`Boolean` — Return YES decisions in explanation (default: false)
`includeDiskInfo`	`Boolean` — Return information about disk usage and shard sizes (default: false)
`body`	`Object`, `JSON` — An optional request body, as either JSON or a JSON serializable object. See the elasticsearch docs for details about what can be specified here.

« cat.threadPool cluster.getSettings »