Reroute the cluster | Elasticsearch API documentation

Query parameters

dry_runboolean
If true, then the request simulates the operation. It will calculate the result of applying the commands to the current cluster state and return the resulting cluster state after the commands (and rebalancing) have been applied; it will not actually perform the requested changes.
explainboolean
If true, then the response contains an explanation of why the commands can or cannot run.
metricstring | array[string]
Limits the information returned to the specified metrics.
retry_failedboolean
If true, then retries allocation of shards that are blocked due to too many subsequent allocation failures.
master_timeoutstring
Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
Values are -1 or 0.
timeoutstring
Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
Values are -1 or 0.

application/json

Body

commandsarray[object]
Defines the commands to perform.
Hide commands attributes Show commands attributes object
- cancelobject
  Hide cancel attributes Show cancel attributes object
  indexstring Required
  shardnumber Required
  nodestring Required
  allow_primaryboolean
- moveobject
  Hide move attributes Show move attributes object
  indexstring Required
  shardnumber Required
  from_nodestring Required
  The node to move the shard from
  to_nodestring Required
  The node to move the shard to
- allocate_replicaobject
  Hide allocate_replica attributes Show allocate_replica attributes object
  indexstring Required
  shardnumber Required
  nodestring Required
- allocate_stale_primaryobject
  Hide allocate_stale_primary attributes Show allocate_stale_primary attributes object
  indexstring Required
  shardnumber Required
  nodestring Required
  accept_data_lossboolean Required
  If a node which has a copy of the data rejoins the cluster later on, that data will be deleted. To ensure that these implications are well-understood, this command requires the flag accept_data_loss to be explicitly set to true
- allocate_empty_primaryobject
  Hide allocate_empty_primary attributes Show allocate_empty_primary attributes object
  indexstring Required
  shardnumber Required
  nodestring Required
  accept_data_lossboolean Required
  If a node which has a copy of the data rejoins the cluster later on, that data will be deleted. To ensure that these implications are well-understood, this command requires the flag accept_data_loss to be explicitly set to true

Responses

200 application/json
Hide response attributes Show response attributes object
- acknowledgedboolean Required
- explanationsarray[object]
  Hide explanations attributes Show explanations attributes object
  commandstring Required
  decisionsarray[object] Required
  Hide decisions attributes Show decisions attributes object
  deciderstring Required
  decisionstring Required
  explanationstring Required
  parametersobject Required
  Hide parameters attributes Show parameters attributes object
  allow_primaryboolean Required
  indexstring Required
  nodestring Required
  shardnumber Required
  from_nodestring
  to_nodestring
- stateobject
  There aren't any guarantees on the output/structure of the raw cluster state. Here you will find the internal representation of the cluster, which can differ from the external representation.

POST /_cluster/reroute

POST /_cluster/reroute?metric=none
{
  "commands": [
    {
      "move": {
        "index": "test", "shard": 0,
        "from_node": "node1", "to_node": "node2"
      }
    },
    {
      "allocate_replica": {
        "index": "test", "shard": 1,
        "node": "node3"
      }
    }
  ]
}

resp = client.cluster.reroute(
    metric="none",
    commands=[
        {
            "move": {
                "index": "test",
                "shard": 0,
                "from_node": "node1",
                "to_node": "node2"
            }
        },
        {
            "allocate_replica": {
                "index": "test",
                "shard": 1,
                "node": "node3"
            }
        }
    ],
)

const response = await client.cluster.reroute({
  metric: "none",
  commands: [
    {
      move: {
        index: "test",
        shard: 0,
        from_node: "node1",
        to_node: "node2",
      },
    },
    {
      allocate_replica: {
        index: "test",
        shard: 1,
        node: "node3",
      },
    },
  ],
});

response = client.cluster.reroute(
  metric: "none",
  body: {
    "commands": [
      {
        "move": {
          "index": "test",
          "shard": 0,
          "from_node": "node1",
          "to_node": "node2"
        }
      },
      {
        "allocate_replica": {
          "index": "test",
          "shard": 1,
          "node": "node3"
        }
      }
    ]
  }
)

$resp = $client->cluster()->reroute([
    "metric" => "none",
    "body" => [
        "commands" => array(
            [
                "move" => [
                    "index" => "test",
                    "shard" => 0,
                    "from_node" => "node1",
                    "to_node" => "node2",
                ],
            ],
            [
                "allocate_replica" => [
                    "index" => "test",
                    "shard" => 1,
                    "node" => "node3",
                ],
            ],
        ),
    ],
]);

curl -X POST -H "Authorization: ApiKey $ELASTIC_API_KEY" -H "Content-Type: application/json" -d '{"commands":[{"move":{"index":"test","shard":0,"from_node":"node1","to_node":"node2"}},{"allocate_replica":{"index":"test","shard":1,"node":"node3"}}]}' "$ELASTICSEARCH_URL/_cluster/reroute?metric=none"

Request example

Run `POST /_cluster/reroute?metric=none` to changes the allocation of shards in a cluster.

{
  "commands": [
    {
      "move": {
        "index": "test", "shard": 0,
        "from_node": "node1", "to_node": "node2"
      }
    },
    {
      "allocate_replica": {
        "index": "test", "shard": 1,
        "node": "node3"
      }
    }
  ]
}