Files
OpenSearch-Docs-Cn/_api-reference/cat/cat-segments.md
T

64 lines
1.6 KiB
Markdown
Raw Normal View History

2021-06-21 23:13:40 -07:00
---
layout: default
title: CAT segments
parent: CAT API
2022-10-27 11:50:39 -05:00
2021-06-21 23:13:40 -07:00
nav_order: 55
has_children: false
2023-05-04 11:22:52 -07:00
redirect_from:
- /opensearch/rest-api/cat/cat-segments/
2021-06-21 23:13:40 -07:00
---
# CAT segments
**Introduced 1.0**
2021-07-26 16:14:22 -07:00
{: .label .label-purple }
2021-06-21 23:13:40 -07:00
The cat segments operation lists Lucene segment-level information for each index.
## Example
```
GET _cat/segments?v
```
{% include copy-curl.html %}
2021-06-21 23:13:40 -07:00
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 %}
2021-06-21 23:13:40 -07:00
2023-05-15 14:59:57 -07:00
If you want to get information for more than one index, separate the indexes with commas:
2021-06-21 23:13:40 -07:00
```
GET _cat/segments/index1,index2,index3
```
{% include copy-curl.html %}
2021-06-21 23:13:40 -07:00
## Path and HTTP methods
```
GET _cat/segments
```
## URL parameters
All CAT segments URL parameters are optional.
2021-06-21 23:13:40 -07:00
2023-05-04 11:22:52 -07:00
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), you can specify the following parameters:
2021-06-21 23:13:40 -07:00
Parameter | Type | Description
:--- | :--- | :---
bytes | Byte size | Specify the units for byte size. For example, `7kb` or `6gb`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/)..
cluster_manager_timeout | Time | The amount of time to wait for a connection to the cluster manager node. Default is 30 seconds.
2021-06-21 23:13:40 -07:00
## Response
```json
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
```