opensearch-docs-cn/_api-reference/cat/cat-allocation.md

layout	title	parent	redirect_from	nav_order	has_children
default	CAT allocation	CAT API	/opensearch/rest-api/cat/cat-allocation/	5	false

CAT allocation

Introduced 1.0 {: .label .label-purple }

The CAT allocation operation lists the allocation of disk space for indexes and the number of shards on each node.

Example

GET _cat/allocation?v

{% include copy-curl.html %}

To limit the information to a specific node, add the node name after your query:

GET _cat/allocation/<node_name>

{% include copy-curl.html %}

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

{% include copy-curl.html %}

Path and HTTP methods

GET _cat/allocation?v
GET _cat/allocation/<node_name>

URL parameters

All CAT allocation URL parameters are optional.

In addition to the common URL parameters, you can specify the following parameters:

Parameter	Type	Description
bytes	Byte size	Specify the units for byte size. For example, 7kb or 6gb. For more information, see Supported units.
local	Boolean	Whether to return information from the local node only instead of from the cluster_manager node. Default is false.
cluster_manager_timeout	Time	The amount of time to wait for a connection to the cluster_manager node. Default is 30 seconds.

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