You're viewing version 2.18 of the OpenSearch documentation. This version 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 segments
Introduced 1.0
The cat segments operation lists Lucene segment-level information for each index.
Endpoints
GET /_cat/segments
GET /_cat/segments/{index}
Query parameters
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 | The amount of time allowed to establish a connection to the cluster manager node. | N/A |
format | String | A short version of the 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 |
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 |
Example requests
GET _cat/segments?v
To see only the information about segments of a specific index, add the index name after your query.
GET _cat/segments/<index>?v
If you want to get information for more than one index, separate the indexes with commas:
GET _cat/segments/index1,index2,index3
Example response
index | shard | prirep | ip | segment | generation | docs.count | docs.deleted | size | size.memory | committed | searchable | version | compound
movies | 0 | p | 172.18.0.4 | _0 | 0 | 1 | 0 | 3.5kb | 1364 | true | true | 8.7.0 | true
movies | 0 | r | 172.18.0.3 | _0 | 0 | 1 | 0 | 3.5kb | 1364 | true | true | 8.7.0 | true
Limiting the response size
To limit the number of indexes returned, configure the cat.segments.response.limit.number_of_indices setting. For more information, see Cluster-level CAT response limit settings.