Skip to content

Latest commit

 

History

History
63 lines (45 loc) · 1.65 KB

cat-segments.md

File metadata and controls

63 lines (45 loc) · 1.65 KB
layout title parent nav_order has_children redirect_from
default
CAT segments
CAT API
55
false
/opensearch/rest-api/cat/cat-segments/

CAT segments

Introduced 1.0 {: .label .label-purple }

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

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.

Example requests

GET _cat/segments?v

{% include copy-curl.html %}

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

GET _cat/segments/<index>?v

{% include copy-curl.html %}

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

GET _cat/segments/index1,index2,index3

{% include copy-curl.html %}

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