mirror of
https://github.com/iSharkFly-Docs/opensearch-docs-cn
synced 2025-02-06 08:18:11 +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>
77 lines
2.2 KiB
Markdown
77 lines
2.2 KiB
Markdown
---
|
|
layout: default
|
|
title: Verify Snaphot Repository
|
|
parent: Snapshot APIs
|
|
|
|
nav_order: 4
|
|
---
|
|
|
|
# Verify snapshot repository
|
|
**Introduced 1.0**
|
|
{: .label .label-purple }
|
|
|
|
Verifies that a snapshot repository is functional. Verifies the repository on each node in a cluster.
|
|
|
|
If verification is successful, the verify snapshot repository API returns a list of nodes connected to the snapshot repository. If verification failed, the API returns an error.
|
|
|
|
If you use the Security plugin, you must have the `manage cluster` privilege.
|
|
{: .note}
|
|
|
|
## Path parameters
|
|
|
|
Path parameters are optional.
|
|
|
|
| Parameter | Data type | Description |
|
|
:--- | :--- | :---
|
|
| repository | String | Name of repository to verify. |
|
|
|
|
## Query parameters
|
|
|
|
| Parameter | Data type | Description |
|
|
:--- | :--- | :---
|
|
| cluster_manager_timeout | Time | Amount of time to wait for a connection to the master node. Optional, defaults to `30s`. |
|
|
| timeout | Time | The period of time to wait for a response. If a response is not received before the timeout value, the request fails and returns an error. Defaults to `30s`. |
|
|
|
|
#### Example request
|
|
|
|
The following request verifies that the my-opensearch-repo is functional:
|
|
|
|
````json
|
|
POST /_snapshot/my-opensearch-repo/_verify?timeout=0s&cluster_manager_timeout=50s
|
|
````
|
|
|
|
#### Example response
|
|
|
|
The example that follows corresponds to the request above in the [Example request](#example-request) section.
|
|
|
|
The `POST /_snapshot/my-opensearch-repo/_verify?timeout=0s&cluster_manager_timeout=50s` request returns the following fields:
|
|
|
|
````json
|
|
{
|
|
"nodes" : {
|
|
"by1kztwTRoeCyg4iGU5Y8A" : {
|
|
"name" : "opensearch-node1"
|
|
}
|
|
}
|
|
}
|
|
````
|
|
|
|
In the preceding sample, one node is connected to the snapshot repository. If more were connected, you would see them in the response. Example:
|
|
|
|
````json
|
|
{
|
|
"nodes" : {
|
|
"lcfL6jv2jo6sMEtp4idMvg" : {
|
|
"name" : "node-1"
|
|
},
|
|
"rEPtFT/B+cuuOHnQn0jy4s" : {
|
|
"name" : "node-2"
|
|
}
|
|
}
|
|
````
|
|
|
|
## Response fields
|
|
|
|
| Field | Data type | Description |
|
|
:--- | :--- | :---
|
|
| nodes | Object | A list (not an array) of nodes connected to the snapshot repository. Each node itself is a property where the node ID is the key and the name has an ID (Object) and a name (String). | |