opensearch-docs-cn/_opensearch/rest-api/cat/cat-snapshots.md

47 lines
1.1 KiB
Markdown
Raw Normal View History

2021-06-22 02:13:40 -04:00
---
layout: default
title: cat snapshots
parent: CAT API
2021-06-22 02:13:40 -04:00
grand_parent: REST API reference
nav_order: 65
has_children: false
---
# cat snapshots
2021-07-26 19:14:22 -04:00
Introduced 1.0
{: .label .label-purple }
2021-06-22 02:13:40 -04:00
The cat snapshots operation lists all snapshots for a repository.
## Example
```
GET _cat/snapshots?v
```
## Path and HTTP methods
```
GET _cat/snapshots
```
## URL parameters
All cat snapshots URL parameters are optional.
In addition to the [common URL parameters]({{site.url}}{{site.baseurl}}/opensearch/rest-api/cat/index#common-url-parameters), you can specify the following parameter:
Parameter | Type | Description
:--- | :--- | :---
master_timeout | Time | The amount of time to wait for a connection to the master node. Default is 30 seconds.
time | Time | Specify the units for time. For example, `5d` or `7h`. For more information, see [Supported units]({{site.url}}{{site.baseurl}}/opensearch/units/).
## Response
```json
index | shard | prirep | state | docs | store | ip | | node
plugins | 0 | p | STARTED | 0 | 208b | 172.18.0.4 | odfe-node1
plugins | 0 | r | STARTED | 0 | 208b | 172.18.0.3 | odfe-node2
```