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

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

OpenSearch subproject :rest-api-spec

There is a newer version: 2.17.0

{
  "cluster.allocation_explain":{
    "documentation":{
      "url":"https://opensearch.org/docs/latest/api-reference/cluster-api/cluster-allocation/",
      "description":"Provides explanations for shard allocations in the cluster."
    },
    "stability":"stable",
    "url":{
      "paths":[
        {
          "path":"/_cluster/allocation/explain",
          "methods":[
            "GET",
            "POST"
          ]
        }
      ]
    },
    "params":{
      "include_yes_decisions":{
        "type":"boolean",
        "description":"Return 'YES' decisions in explanation (default: false)"
      },
      "include_disk_info":{
        "type":"boolean",
        "description":"Return information about disk usage and shard sizes (default: false)"
      }
    },
    "body":{
      "description":"The index, shard, and primary flag to explain. Empty means 'explain the first unassigned shard'"
    }
  }
}