Skip to content

Update get snapshot status API doc #111240

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.

Sign up for GitHub

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
merged 3 commits into from
Jul 25, 2024
Merged

Update get snapshot status API doc #111240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fc9ed8c
Update get snapshot status API doc
pxsalehi Jul 24, 2024
08873c5
simplify comment and remove todo
pxsalehi Jul 25, 2024
7cefe9a
Merge branch 'main' into ps240724-update-get-snapshot-status-api-doc
elasticmachine Jul 25, 2024
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
9 changes: 2 additions & 7 deletions docs/reference/snapshot-restore/apis/get-snapshot-status-api.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<titleabbrev>Get snapshot status</titleabbrev>
++++

Retrieves a detailed description of the current state for each shard participating in the snapshot.
Retrieves a detailed description of the current state for each shard participating in the snapshot. Note that this API should only be used to obtain detailed shard-level information for ongoing snapshots. If this detail is not needed, or you want to obtain information about one or more existing snapshots, use the <<get-snapshot-api,get snapshot API>>.

////
[source,console]
Expand Down Expand Up @@ -172,13 +172,8 @@ Indicates the current snapshot state.
`STARTED`::
The snapshot is currently running.

`PARTIAL`::
The global cluster state was stored, but data of at least one shard was not stored successfully.
The <<get-snapshot-api-response-failures,`failures`>> section of the response contains more detailed information about shards
that were not processed correctly.

`SUCCESS`::
The snapshot finished and all shards were stored successfully.
The snapshot completed.
====
--

Expand Down
3 changes: 1 addition & 2 deletions ...g/elasticsearch/action/admin/cluster/snapshots/status/TransportSnapshotsStatusAction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -332,8 +332,7 @@ private void loadRepositoryData(
final SnapshotsInProgress.State state = switch (snapshotInfo.state()) {
case FAILED -> SnapshotsInProgress.State.FAILED;
case SUCCESS, PARTIAL ->
// Translating both PARTIAL and SUCCESS to SUCCESS for now
// TODO: add the differentiation on the metadata level in the next major release
// Both of these means the snapshot has completed.
SnapshotsInProgress.State.SUCCESS;
default -> throw new IllegalArgumentException("Unexpected snapshot state " + snapshotInfo.state());
};
Expand Down