CAT segments

Introduced 1.0

The cat segments operation lists Lucene segment-level information for each index.

Example

  1. GET _cat/segments?v

copy

To see only the information about segments of a specific index, add the index name after your query.

  1. GET _cat/segments/<index>?v

copy

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

  1. GET _cat/segments/index1,index2,index3

copy

Path and HTTP methods

  1. GET _cat/segments

URL parameters

All CAT segments URL parameters are optional.

In addition to the common URL parameters, you can specify the following parameter:

ParameterTypeDescription
bytesByte sizeSpecify the units for byte size. For example, 7kb or 6gb. For more information, see Supported units..
cluster_manager_timeoutTimeThe amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.

Response

  1. index | shard | prirep | ip | segment | generation | docs.count | docs.deleted | size | size.memory | committed | searchable | version | compound
  2. movies | 0 | p | 172.18.0.4 | _0 | 0 | 1 | 0 | 3.5kb | 1364 | true | true | 8.7.0 | true
  3. movies | 0 | r | 172.18.0.3 | _0 | 0 | 1 | 0 | 3.5kb | 1364 | true | true | 8.7.0 | true