Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Add verify snapshot repository API docs #57253

Merged
merged 1 commit into from
May 28, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/reference/snapshot-restore/apis/put-repo-api.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ data nodes in the cluster. If `false`, this verification is skipped. Defaults to
`true`.
+
You can manually perform this verification using the
<<snapshots-repository-verification,verify snapshot repository API>>.
<<verify-snapshot-repo-api,verify snapshot repository API>>.
+
IMPORTANT: You can also specify this value using the `verify` request body
parameter. If both parameters are specified, only the query parameter is used.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,11 @@ content may not be included yet.
* <<delete-snapshot-repo-api,Delete snapshot repository>>
* <<get-snapshot-repo-api,Get snapshot repository>>
* <<put-snapshot-repo-api,Put snapshot repository>>
* <<verify-snapshot-repo-api,Verify snapshot repository>>


include::clean-up-repo-api.asciidoc[]
include::delete-repo-api.asciidoc[]
include::get-repo-api.asciidoc[]
include::put-repo-api.asciidoc[]
include::put-repo-api.asciidoc[]
include::verify-repo-api.asciidoc[]
94 changes: 94 additions & 0 deletions docs/reference/snapshot-restore/apis/verify-repo-api.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
[[verify-snapshot-repo-api]]
=== Verify snapshot repository API
++++
<titleabbrev>Verify snapshot repository</titleabbrev>
++++

Verifies that a snapshot repository is functional.

////
[source,console]
----
PUT /_snapshot/my_repository
{
"type": "fs",
"settings": {
"location": "my_backup_location"
}
}
----
// TESTSETUP
////

[source,console]
----
POST /_snapshot/my_repository/_verify
----

[[verify-snapshot-repo-api-request]]
==== {api-request-title}

`POST /_snapshot/<repository>/_verify`

[[verify-snapshot-repo-api-desc]]
==== {api-description-title}

By default, <<put-snapshot-repo-api,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.

[[verify-snapshot-repo-api-path-params]]
==== {api-path-parms-title}

`<repository>`::
(Required, string)
Name of the snapshot repository to verify.

[[verify-snapshot-repo-api-query-params]]
==== {api-query-parms-title}

`master_timeout`::
(Optional, <<time-units, 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, 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`.

[role="child_attributes"]
[[verify-snapshot-repo-api-response-body]]
==== {api-response-body-title}

`nodes`::
(object)
+
.Properties of `nodes` objects
[%collapsible%open]
====
`<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>`
[%collapsible%open]
=====
`name`::
(string)
Human-readable name for the node.
+
You can set this name using the <<node.name,`node.name`>> property in
`elasticsearch.yml`. Defaults to the machine's hostname.
=====
====