CAT shards
Introduced 1.0
The CAT shards operation lists the state of all primary and replica shards and how they are distributed.
Endpoints
GET _cat/shards
Query parameters
All parameters are optional.
In addition to the common 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. |
| cancel_after_time_interval | Time | The amount of time after which the shard request will be canceled. Default is -1. |
| time | Time | Specify the units for time. For example, 5d or 7h. For more information, see Supported units. |
Example requests
The following example requests returns information about shards:
GET _cat/shards?v
To see only the information about shards of a specific index, add the index name after your query.
GET _cat/shards/<index>?v
If you want to get information for more than one index, separate the indexes with commas:
GET _cat/shards/index1,index2,index3
Example response
index | shard | prirep | state | docs | store | ip | | node
plugins | 0 | p | STARTED | 0 | 208b | 172.18.0.4 | odfe-node1
plugins | 0 | r | STARTED | 0 | 208b | 172.18.0.3 | odfe-node2
Limiting the response size
To limit the number of shards returned, configure the cat.shards.response.limit.number_of_shards setting. For more information, see Cluster-level CAT response limit settings.