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
« cluster.remoteInfo cluster.state »

cluster.rerouteedit

client.cluster.reroute({
  dry_run: boolean,
  explain: boolean,
  retry_failed: boolean,
  metric: string | string[],
  master_timeout: string,
  timeout: string,
  body: object
})

Reference

dry_run or 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

retry_failed or retryFailed

boolean - Retries allocation of shards that are blocked due to too many subsequent allocation failures

metric

string | string[] - Limit the information returned to the specified metrics. Defaults to all but metadata

master_timeout or masterTimeout

string - Explicit operation timeout for connection to master node

timeout

string - Explicit operation timeout

body

object - The definition of commands to perform (move, cancel, allocate)
« cluster.remoteInfo cluster.state »