rest-api-spec.api.cluster.reroute.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of rest-api-spec Show documentation

Elasticsearch subproject :rest-api-spec

There is a newer version: 8.16.0

{
  "cluster.reroute":{
    "documentation":{
      "url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-reroute.html",
      "description":"Allows to manually change the allocation of individual shards in the cluster."
    },
    "stability":"stable",
    "visibility":"public",
    "headers":{
      "accept": [ "application/json"],
      "content_type": ["application/json"]
    },
    "url":{
      "paths":[
        {
          "path":"/_cluster/reroute",
          "methods":[
            "POST"
          ]
        }
      ]
    },
    "params":{
      "dry_run":{
        "type":"boolean",
        "description":"Simulate the operation only and return the resulting state"
      },
      "explain":{
        "type":"boolean",
        "description":"Return an explanation of why the commands can or cannot be executed"
      },
      "retry_failed":{
        "type":"boolean",
        "description":"Retries allocation of shards that are blocked due to too many subsequent allocation failures"
      },
      "metric":{
        "type":"list",
        "options":[
          "_all",
          "blocks",
          "metadata",
          "nodes",
          "none",
          "routing_table",
          "master_node",
          "version"
        ],
        "description":"Limit the information returned to the specified metrics. Defaults to all but metadata"
      },
      "master_timeout":{
        "type":"time",
        "description":"Explicit operation timeout for connection to master node"
      },
      "timeout":{
        "type":"time",
        "description":"Explicit operation timeout"
      }
    },
    "body":{
      "description":"The definition of `commands` to perform (`move`, `cancel`, `allocate`)"
    }
  }
}