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.

« cluster.remoteInfo cluster.state »
Elastic Docs ›elasticsearch.js ›7.3 API

cluster.reroute

edit

cluster.reroute

edit
client.cluster.reroute([params, [callback]])

Explicitly execute a cluster reroute allocation command including specific commands.

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

Params

dryRun

Boolean — Simulate the operation only and return the resulting state

explain

Boolean — Return an explanation of why the commands can or cannot be executed

retryFailed

Boolean — Retries allocation of shards that are blocked due to too many subsequent allocation failures

metric

String, String[], Boolean — Limit the information returned to the specified metrics. Defaults to all but metadata

masterTimeout

DurationString — Explicit operation timeout for connection to master node

timeout

DurationString — Explicit operation timeout

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.

back to top

« cluster.remoteInfo cluster.state »