mirror of
https://github.com/iSharkFly-Docs/opensearch-docs-cn
synced 2025-03-08 11:19:34 +00:00
84e4ab158e
* Fix APIs File Signed-off-by: samipak458 <samipak458@gmail.com> * Update API files according to API template Signed-off-by: samipak458 <samipak458@gmail.com> * Update exec-stored-script.md Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> * Update cat-aliases.md Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com> * Update cat-allocation.md Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com> * Update cat-cluster_manager.md Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com> * Update cat-count.md Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com> * Update cat-field-data.md Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com> * Update cat-health.md Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com> * updated * updated * updated --------- Signed-off-by: samipak458 <samipak458@gmail.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: MUHAMMAD SAMIULLAH <samipak458@gmail.com> Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
64 lines
1.6 KiB
Markdown
64 lines
1.6 KiB
Markdown
---
|
|
layout: default
|
|
title: CAT segments
|
|
parent: CAT API
|
|
|
|
nav_order: 55
|
|
has_children: false
|
|
redirect_from:
|
|
- /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.
|
|
|
|
## Example
|
|
|
|
```
|
|
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 %}
|
|
|
|
## Path and HTTP methods
|
|
|
|
```
|
|
GET _cat/segments
|
|
```
|
|
|
|
## URL parameters
|
|
|
|
All CAT segments URL parameters are optional.
|
|
|
|
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/api-reference/cat/index), 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]({{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.
|
|
|
|
|
|
## 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
|
|
```
|