-
Notifications
You must be signed in to change notification settings - Fork 473
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
Add 'Cleanup Snapshot' API Documentation #8373
Merged
Naarcha-AWS
merged 11 commits into
opensearch-project:main
from
Reiyadowns:add-cleanup-snapshot-docs
Oct 3, 2024
Merged
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
936c7ab
Add documentation for Clone Snapshot API
Reiyadowns 6505789
Add documentation for Cleanup Snapshot Repository API
Reiyadowns fea8f00
Fixed minor errors, light editing
Reiyadowns 65431f4
Remove erroneous clone-repository file
Reiyadowns 7bdaafa
Merge branch 'main' into add-cleanup-snapshot-docs
Reiyadowns 7f19a12
Merge branch 'main' into add-cleanup-snapshot-docs
Reiyadowns ca3a98c
Merge branch 'main' into add-cleanup-snapshot-docs
Naarcha-AWS 3b8769a
Update cleanup-snapshot-repository.md
Naarcha-AWS eec51e1
Merge branch 'main' into add-cleanup-snapshot-docs
Naarcha-AWS e7f26ff
Apply suggestions from code review
Naarcha-AWS 8d628b0
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 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,64 @@ | ||
--- | ||
layout: default | ||
title: Cleanup Snapshot Repository | ||
parent: Snapshot APIs | ||
nav_order: 11 | ||
--- | ||
|
||
# Cleanup Snapshot Repository | ||
Check failure on line 8 in _api-reference/snapshots/cleanup-snapshot-repository.md GitHub Actions / style-job
|
||
Introduced 1.0 | ||
{: .label .label-purple } | ||
|
||
The Cleanup Snapshot Repository API clears a snapshot repository of data no longer referenced by any existing snapshot. | ||
|
||
## Path and HTTP methods | ||
|
||
```json | ||
POST /_snapshot/<repository>/_cleanup | ||
``` | ||
{% include copy.html %} | ||
|
||
|
||
## Path parameters | ||
|
||
| Parameter | Data type | Description | | ||
| :--- | :--- | :--- | | ||
| `repository` | String | The name of the snapshot repository. | | ||
|
||
## Query parameters | ||
|
||
The following table lists the available query parameters. All query parameters are optional. | ||
|
||
| Parameter | Data type | Description | | ||
| :--- | :--- | :--- | | ||
| `cluster_manager_timeout` | Time | The amount of time to wait for a response from the cluster manager node. Formerly called `master_timeout`. Optional. Default is 30 seconds. | | ||
| `timeout` | Time | The amount of time to wait for the operation to complete. Optional.| | ||
|
||
## Example request | ||
|
||
The following request removes all stale data from the repository `my_backup`: | ||
|
||
```json | ||
POST /_snapshot/my_backup/_cleanup | ||
``` | ||
{% include copy-curl.html %} | ||
|
||
|
||
## Example response | ||
|
||
```json | ||
{ | ||
"results":{ | ||
"deleted_bytes":40, | ||
"deleted_blobs":8 | ||
} | ||
} | ||
``` | ||
|
||
## Response body fields | ||
|
||
| Field | Data type | Description | | ||
| :--- | :--- | :--- | | ||
| `deleted_bytes` | Integer | The number of bytes made available in the snapshot after data deletion. | | ||
| `deleted_blobs` | Integer | The number of binary large objects (BLOBs) cleared from the repository by the request. | | ||
|
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Below: Can we use something more precise than "freed"? Do we mean something like "The number of bytes made available by data deletion"?