mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 15:47:23 -04:00
d2dbef5063
Closes #81652. Convert the `repository-azure`, `repository-gcs` and `repository-s3` plugins into modules, so that they are always included in the Elasticsearch distribution. Also change plugin installation, removal and syncing so that attempting to add or remove these plugins still succeeds but is now a no-op.
140 lines
3.4 KiB
Text
140 lines
3.4 KiB
Text
[[get-snapshot-repo-api]]
|
|
=== Get snapshot repository API
|
|
++++
|
|
<titleabbrev>Get snapshot repository</titleabbrev>
|
|
++++
|
|
|
|
Gets information about one or more registered
|
|
<<snapshots-register-repository,snapshot repositories>>.
|
|
|
|
////
|
|
[source,console]
|
|
----
|
|
PUT /_snapshot/my_repository
|
|
{
|
|
"type": "fs",
|
|
"settings": {
|
|
"location": "my_backup_location"
|
|
}
|
|
}
|
|
----
|
|
// TESTSETUP
|
|
////
|
|
|
|
[source,console]
|
|
----
|
|
GET /_snapshot/my_repository
|
|
----
|
|
|
|
[[get-snapshot-repo-api-request]]
|
|
==== {api-request-title}
|
|
|
|
`GET /_snapshot/<repository>`
|
|
|
|
`GET /_snapshot`
|
|
|
|
[[get-snapshot-repo-api-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
* If the {es} {security-features} are enabled, you must have the
|
|
`monitor_snapshot`, `create_snapshot`, or `manage`
|
|
<<privileges-list-cluster,cluster privilege>> to use this API.
|
|
|
|
[[get-snapshot-repo-api-path-params]]
|
|
==== {api-path-parms-title}
|
|
|
|
`<repository>`::
|
|
(Optional, string)
|
|
Comma-separated list of snapshot repository names used to limit the request.
|
|
Wildcard (`*`) expressions are supported including combining wildcards with exclude patterns starting with `-`.
|
|
+
|
|
To get information about all snapshot repositories registered in the
|
|
cluster, omit this parameter or use `*` or `_all`.
|
|
|
|
[[get-snapshot-repo-api-query-params]]
|
|
==== {api-query-parms-title}
|
|
|
|
`local`::
|
|
(Optional, Boolean) If `true`, the request gets information from the local node
|
|
only. If `false`, the request gets information from the master node. Defaults to
|
|
`false`.
|
|
|
|
`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`.
|
|
|
|
[role="child_attributes"]
|
|
[[get-snapshot-repo-api-response-body]]
|
|
==== {api-response-body-title}
|
|
|
|
`<repository>`::
|
|
(object)
|
|
Contains information about the snapshot repository. Key is the name of the
|
|
snapshot repository.
|
|
+
|
|
.Properties of `<repository>`
|
|
[%collapsible%open]
|
|
====
|
|
`type`::
|
|
+
|
|
--
|
|
(string)
|
|
Repository type.
|
|
|
|
.Values for `type`
|
|
[%collapsible%open]
|
|
=====
|
|
`fs`::
|
|
Shared file system repository. See <<snapshots-filesystem-repository>>.
|
|
|
|
[xpack]#`source`#::
|
|
Source-only repository. See <<snapshots-source-only-repository>>.
|
|
|
|
`url`::
|
|
URL repository. See <<snapshots-read-only-repository>>.
|
|
=====
|
|
|
|
More repository types are available through these official plugins:
|
|
|
|
* <<repository-s3, repository-s3>> for S3 repository support
|
|
* {plugins}/repository-hdfs.html[repository-hdfs] for HDFS repository support in
|
|
Hadoop environments
|
|
* <<repository-azure,repository-azure>> for Azure storage repositories
|
|
* <<repository-gcs,repository-gcs>> for Google Cloud Storage repositories
|
|
--
|
|
|
|
`settings`::
|
|
(object)
|
|
Contains settings for the repository. Valid properties for the `settings` object
|
|
depend on the repository type, set using the
|
|
<<put-snapshot-repo-api-request-type,`type`>> parameter.
|
|
+
|
|
For properties, see the <<put-snapshot-repo-api,create or update snapshot
|
|
repository API>>'s <<put-snapshot-repo-api-settings-param,`settings`
|
|
parameter>>.
|
|
====
|
|
|
|
[[get-snapshot-repo-api-example]]
|
|
==== {api-examples-title}
|
|
|
|
[source,console]
|
|
----
|
|
GET /_snapshot/my_repository
|
|
----
|
|
|
|
The API returns the following response:
|
|
|
|
[source,console-result]
|
|
----
|
|
{
|
|
"my_repository" : {
|
|
"type" : "fs",
|
|
"uuid" : "0JLknrXbSUiVPuLakHjBrQ",
|
|
"settings" : {
|
|
"location" : "my_backup_location"
|
|
}
|
|
}
|
|
}
|
|
----
|
|
// TESTRESPONSE[s/"uuid" : "0JLknrXbSUiVPuLakHjBrQ"/"uuid" : $body.my_repository.uuid/]
|