IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
cat allocation APIedit
Provides a snapshot of the number of shards allocated to each data node and their disk space.
Path parametersedit
-
<node_id> - (Optional, string) Comma-separated list of node IDs or names used to limit returned information.
Query parametersedit
-
bytes - (Optional, byte size units) Unit used to display byte values.
-
format - (Optional, string) Short version of the HTTP accept header. Valid values include JSON, YAML, etc.
-
local -
(Optional, boolean) If
true, the request retrieves information from the local node only. Defaults tofalse, which means information is retrieved from the master node. -
master_timeout -
(Optional, time units) Specifies the period of time 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. Defaults to
30s. -
h - (Optional, string) Comma-separated list of column names to display.
-
help -
(Optional, boolean) If
true, the response includes help information. Defaults tofalse. -
s - (Optional, string) Comma-separated list of column names or column aliases used to sort the response.
-
v -
(Optional, boolean) If
true, the response includes column headings. Defaults tofalse.
Examplesedit
GET /_cat/allocation?v
The API returns the following response:
shards disk.indices disk.used disk.avail disk.total disk.percent host ip node
1 260b 47.3gb 43.4gb 100.7gb 46 127.0.0.1 127.0.0.1 CSUXak2
This response shows a single shard is allocated to the one node available.