rest-api-spec.api.cat.allocation.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
Show all versions of rest-api-spec Show documentation
Elasticsearch subproject :rest-api-spec
{
"cat.allocation":{
"documentation":{
"url":"https://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html",
"description":"Provides a snapshot of how many shards are allocated to each data node and how much disk space they are using."
},
"stability":"stable",
"visibility":"public",
"headers":{
"accept": [ "text/plain", "application/json"]
},
"url":{
"paths":[
{
"path":"/_cat/allocation",
"methods":[
"GET"
]
},
{
"path":"/_cat/allocation/{node_id}",
"methods":[
"GET"
],
"parts":{
"node_id":{
"type":"list",
"description":"A comma-separated list of node IDs or names to limit the returned information"
}
}
}
]
},
"params":{
"format":{
"type":"string",
"description":"a short version of the Accept header, e.g. json, yaml"
},
"bytes":{
"type":"enum",
"description":"The unit in which to display byte values",
"options":[
"b",
"k",
"kb",
"m",
"mb",
"g",
"gb",
"t",
"tb",
"p",
"pb"
]
},
"local":{
"type":"boolean",
"description":"Return local information, do not retrieve the state from master node (default: false)"
},
"master_timeout":{
"type":"time",
"description":"Explicit operation timeout for connection to master node"
},
"h":{
"type":"list",
"description":"Comma-separated list of column names to display"
},
"help":{
"type":"boolean",
"description":"Return help information",
"default":false
},
"s":{
"type":"list",
"description":"Comma-separated list of column names or column aliases to sort by"
},
"v":{
"type":"boolean",
"description":"Verbose mode. Display column headers",
"default":false
}
}
}
}