This version of the OpenSearch documentation is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

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.

Example

  1. GET _cat/allocation?v

copy

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

  1. GET _cat/allocation/<node_name>

copy

If you want to get information for more than one node, separate the node names with commas:

  1. GET _cat/allocation/node_name_1,node_name_2,node_name_3

copy

Path and HTTP methods

  1. GET _cat/allocation?v
  2. 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:

ParameterTypeDescription
bytesByte sizeSpecify the units for byte size. For example, 7kb or 6gb. For more information, see Supported units.
localBooleanWhether to return information from the local node only instead of from the cluster_manager node. Default is false.
cluster_manager_timeoutTimeThe 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:

  1. shards | disk.indices | disk.used | disk.avail | disk.total | disk.percent host | ip          | node
  2.   8    |   989.4kb    |   25.9gb  |   32.4gb   |   58.4gb   |   44 172.18.0.4   | 172.18.0.4  | odfe-node1
  3.   8    |   962.4kb    |   25.9gb  |   32.4gb   |   58.4gb   |   44 172.18.0.3   | 172.18.0.3  | odfe-node2