generated from amazon-archives/__template_Apache-2.0
-
Notifications
You must be signed in to change notification settings - Fork 623
Add 'Clone Snapshot' API Documentation #8371
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
Merged
Naarcha-AWS
merged 21 commits into
opensearch-project:main
from
Reiyadowns:add-clone-snapshot-docs
Mar 28, 2025
Merged
Changes from 19 commits
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
ab80caa
Add documentation for Clone Snapshot API
Reiyadowns 4a351b4
Light edits
Reiyadowns 4cde4ca
Fixed title
Reiyadowns a01d0e0
Merge branch 'main' into add-clone-snapshot-docs
Reiyadowns b7d05e3
Remove unnecessary clone-repository file
Reiyadowns 1c08e63
Merge branch 'add-clone-snapshot-docs' of https://github.com/Reiyadow…
Reiyadowns 6ac9fa0
Merge branch 'main' into add-clone-snapshot-docs
Reiyadowns f157164
Merge branch 'main' into add-clone-snapshot-docs
Naarcha-AWS 34e8360
Merge branch 'main' into add-clone-snapshot-docs
Reiyadowns f968ac8
Merge branch 'main' into add-clone-snapshot-docs
Naarcha-AWS 4b3818d
Merge branch 'main' into add-clone-snapshot-docs
Reiyadowns 24c6842
Merge branch 'main' into add-clone-snapshot-docs
Naarcha-AWS f319a8e
Merge branch 'main' into add-clone-snapshot-docs
Naarcha-AWS ddc982a
Update page with automation markers
Naarcha-AWS c0e724f
Remove response body.
Naarcha-AWS 9672848
Apply suggestions from code review
Naarcha-AWS 38b7321
Merge branch 'main' into add-clone-snapshot-docs
Naarcha-AWS 028382a
Update clone-snapshot.md
Naarcha-AWS 4feb956
Apply suggestions from code review
Naarcha-AWS 513f158
Apply suggestions from code review
Naarcha-AWS e89a359
Apply suggestions from code review
Naarcha-AWS File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| --- | ||
| layout: default | ||
| title: Clone snapshot | ||
| parent: Snapshot APIs | ||
| nav_order: 10 | ||
| --- | ||
|
|
||
| # Clone snapshot | ||
| Introduced 1.0 | ||
| {: .label .label-purple } | ||
|
|
||
| Creates a clone of all or part of a snapshot, in the same repository as the original. | ||
|
|
||
|
|
||
| <!-- spec_insert_start | ||
| api: snapshot.clone | ||
| component: endpoints | ||
| --> | ||
| ## Endpoints | ||
| ```json | ||
| PUT /_snapshot/{repository}/{snapshot}/_clone/{target_snapshot} | ||
| ``` | ||
| <!-- spec_insert_end --> | ||
|
|
||
| <!-- spec_insert_start | ||
| api: snapshot.clone | ||
| component: path_parameters | ||
| --> | ||
| ## Path parameters | ||
|
|
||
| The following table lists the available path parameters. | ||
|
|
||
| | Parameter | Required | Data type | Description | | ||
| | :--- | :--- | :--- | :--- | | ||
| | `repository` | **Required** | String | The name of repository which will contain the snapshots clone. | | ||
Naarcha-AWS marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| | `snapshot` | **Required** | String | The name of the original snapshot. | | ||
| | `target_snapshot` | **Required** | String | The name of the cloned snapshot. | | ||
|
|
||
| <!-- spec_insert_end --> | ||
|
|
||
|
|
||
| <!-- spec_insert_start | ||
| api: snapshot.clone | ||
| component: query_parameters | ||
| include_deprecated: false | ||
| --> | ||
| ## Query parameters | ||
|
|
||
| The following table lists the available query parameters. All query parameters are optional. | ||
|
|
||
| | Parameter | Data type | Description | | ||
| | :--- | :--- | :--- | | ||
| | `cluster_manager_timeout` | String | The amount of time to wait for a response from the cluster manager node. For more information about supported time units, see [Common parameters]({{site.url}}{{site.baseurl}}/api-reference/common-parameters/#time-units). | | ||
|
|
||
| <!-- spec_insert_end --> | ||
|
|
||
|
|
||
| ## Example request | ||
|
|
||
| The following request copies indices `index_a` and `index_b` from `my_snapshot`, a snapshot located in repository `my-opensearch-repo`, into a new snapshot in the same repository called `my_new_snapshot`: | ||
Naarcha-AWS marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| ```json | ||
| PUT /_snapshot/my-opensearch-repo/my_snapshot/_clone/my_new_snapshot | ||
| { | ||
| “indices” : “index_a,index_b” | ||
| } | ||
| ``` | ||
| {% include copy-curl.html %} | ||
|
|
||
|
|
||
| ## Example response | ||
|
|
||
| The following example shows an API response: | ||
|
||
|
|
||
| ```json | ||
| { | ||
| "acknowledged" : true | ||
| } | ||
| ``` | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.