CAT allocation
Introduced 1.0
The CAT allocation operation lists the allocation of disk space for indexes and the number of shards on each node.
Endpoints
GET /_cat/allocation
GET /_cat/allocation/{node_id}
Query parameters
«««< HEAD Parameter | Type | Description | Default :— | :— | :— | :— bytes | String | The units used to display byte values. | cluster_manager_timeout | String | A timeout for connection to the cluster manager node. | format | String | A short version of the HTTP Accept header, such as json or yaml. | h | List | A comma-separated list of column names to display. | help | Boolean | Returns help information. | false local | Boolean | Returns local information but does not retrieve the state from cluster manager node. | false s | List | A comma-separated list of column names or column aliases to sort by. | v | Boolean | Enables verbose mode, which displays column headers. | false =======
The following table lists the available query parameters. All query parameters are optional.
| Parameter | Data type | Description | Default |
|---|---|---|---|
bytes | String | The units used to display byte values. Valid values are: b, kb, k, mb, m, gb, g, tb, t, pb, p | N/A |
cluster_manager_timeout | String | A timeout for connection to the cluster manager node. | N/A |
format | String | A short version of the HTTP Accept header, such as json or yaml. | N/A |
h | List | A comma-separated list of column names to display. | N/A |
help | Boolean | Returns help information. | false |
local | Boolean | Returns local information but does not retrieve the state from cluster-manager node. | false |
s | List | A comma-separated list of column names or column aliases to sort by. | N/A |
v | Boolean | Enables verbose mode, which displays column headers. | false |
0713861e (CAT API automation (Part II) (#9060))
Example requests
GET _cat/allocation?v
To limit the information to a specific node, add the node name after your query:
GET _cat/allocation/<node_name>
If you want to get information for more than one node, separate the node names with commas:
GET _cat/allocation/node_name_1,node_name_2,node_name_3
Example response
The following response shows that eight shards are allocated to each of the two nodes available:
shards | disk.indices | disk.used | disk.avail | disk.total | disk.percent host | ip | node
8 | 989.4kb | 25.9gb | 32.4gb | 58.4gb | 44 172.18.0.4 | 172.18.0.4 | odfe-node1
8 | 962.4kb | 25.9gb | 32.4gb | 58.4gb | 44 172.18.0.3 | 172.18.0.3 | odfe-node2