| layout | title | parent | nav_order | has_children | redirect_from | canonical_url | |
|---|---|---|---|---|---|---|---|
default |
CAT indices |
CAT API |
25 |
false |
|
Introduced 1.0 {: .label .label-purple }
The CAT indices operation lists information related to indexes, that is, how much disk space they are using, how many shards they have, their health status, and so on.
GET _cat/indices/<index>
GET _cat/indices| Parameter | Type | Description |
|---|---|---|
| bytes | Byte size | Specify the units for byte size. For example, 7kb or 6gb. For more information, see Supported units. |
| health | String | Limit indexes based on their health status. Supported values are green, yellow, and red. |
| include_unloaded_segments | Boolean | Whether to include information from segments not loaded into memory. 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. |
| pri | Boolean | Whether to return information only from the primary shards. Default is false. |
| time | Time | Specify the units for time. For example, 5d or 7h. For more information, see Supported units. |
| expand_wildcards | Enum | Expands wildcard expressions to concrete indexes. Combine multiple values with commas. Supported values are all, open, closed, hidden, and none. Default is open. |
GET _cat/indices?v{% include copy-curl.html %}
To limit the information to a specific index, add the index name after your query.
GET _cat/indices/<index>?v{% include copy-curl.html %}
If you want to get information for more than one index, separate the indexes with commas:
GET _cat/indices/index1,index2,index3{% include copy-curl.html %}
health | status | index | uuid | pri | rep | docs.count | docs.deleted | store.size | pri.store.size
green | open | movies | UZbpfERBQ1-3GSH2bnM3sg | 1 | 1 | 1 | 0 | 7.7kb | 3.8kb