本地英文版地址: ../en/verify-snapshot-repo-api.html
Verify snapshot repository APIedit
Verifies that a snapshot repository is functional.
POST /_snapshot/my_repository/_verify
Requestedit
POST /_snapshot/<repository>/_verify
Descriptionedit
By default, put snapshot repository API requests verify that a snapshot is functional on all master and data nodes in the cluster.
You can skip this verification using the put snapshot repository API’s verify
parameter. You can then use the verify snapshot repository API to manually
verify the repository.
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.
Path parametersedit
-
<repository>
- (Required, string) Name of the snapshot repository to verify.
Query parametersedit
-
master_timeout
-
(Optional, time units) Specifies the period of time to wait for
a connection to the master node. If no response is received before the timeout
expires, the request fails and returns an error. Defaults to
30s
. -
timeout
-
(Optional, time units) Specifies the period of time to wait for
a response. If no response is received before the timeout expires, the request
fails and returns an error. Defaults to
30s
.
Response bodyedit
-
nodes
-
(object)
Properties of
nodes
objects-
<node_id>
-
(object) Contains information about a node connected to the snapshot repository.
The key is the ID of the node.
Properties of
<node_id>
-
name
-
(string) Human-readable name for the node.
You can set this name using the
node.name
property inelasticsearch.yml
. Defaults to the machine’s hostname.
-
-