Link Search Menu Expand Document Documentation Menu

You're viewing version 2.13 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.

Example

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

Path and HTTP methods

GET _cat/segments

URL parameters

All CAT segments 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..
cluster_manager_timeout Time The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.

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
350 characters left

Have a question? .

Want to contribute? or .