mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 15:47:23 -04:00
777598d602
* [DOCS] Remove manual redirects * [DOCS] Removed refs to modules-discovery-hosts-providers * [DOCS] Fixed broken internal refs * Fixing bad cross links in ES book, and adding redirects.asciidoc[] back into docs/reference/index.asciidoc. * Update docs/reference/search/point-in-time-api.asciidoc Co-authored-by: James Rodewig <james.rodewig@elastic.co> * Update docs/reference/setup/restart-cluster.asciidoc Co-authored-by: James Rodewig <james.rodewig@elastic.co> * Update docs/reference/sql/endpoints/translate.asciidoc Co-authored-by: James Rodewig <james.rodewig@elastic.co> * Update docs/reference/snapshot-restore/restore-snapshot.asciidoc Co-authored-by: James Rodewig <james.rodewig@elastic.co> * Update repository-azure.asciidoc * Update node-tool.asciidoc * Update repository-azure.asciidoc --------- Co-authored-by: amyjtechwriter <61687663+amyjtechwriter@users.noreply.github.com> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> Co-authored-by: Amy Jonsson <amy.jonsson@elastic.co> Co-authored-by: James Rodewig <james.rodewig@elastic.co>
58 lines
No EOL
1.6 KiB
Text
58 lines
No EOL
1.6 KiB
Text
[[clone-snapshot-api]]
|
|
=== Clone snapshot API
|
|
++++
|
|
<titleabbrev>Clone snapshot</titleabbrev>
|
|
++++
|
|
|
|
Clones part or all of a snapshot into a new snapshot.
|
|
|
|
[source,console]
|
|
----
|
|
PUT /_snapshot/my_repository/source_snapshot/_clone/target_snapshot
|
|
{
|
|
"indices": "index_a,index_b"
|
|
}
|
|
----
|
|
// TEST[skip:TODO]
|
|
|
|
[[clone-snapshot-api-request]]
|
|
==== {api-request-title}
|
|
|
|
`PUT /_snapshot/<repository>/<source_snapshot>/_clone/<target_snapshot>`
|
|
|
|
[[clone-snapshot-api-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
* If the {es} {security-features} are enabled, you must have the `manage`
|
|
<<privileges-list-cluster,cluster privilege>> to use this API.
|
|
|
|
[[clone-snapshot-api-desc]]
|
|
==== {api-description-title}
|
|
|
|
The clone snapshot API allows creating a copy of all or part of an existing snapshot
|
|
within the same repository.
|
|
|
|
[[clone-snapshot-api-params]]
|
|
==== {api-path-parms-title}
|
|
|
|
`<repository>`::
|
|
(Required, string)
|
|
Name of the snapshot repository that both source and target snapshot belong to.
|
|
|
|
[[clone-snapshot-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`.
|
|
|
|
`indices`::
|
|
(Required, string)
|
|
A comma-separated list of indices to include in the snapshot.
|
|
<<api-multi-index,multi-target syntax>> is supported. |