Skip to content

Commit

Permalink
Update get snapshot status API doc
Browse files Browse the repository at this point in the history
  • Loading branch information
pxsalehi committed Jul 24, 2024
1 parent 0b9b2a9 commit fc9ed8c
Showing 1 changed file with 2 additions and 7 deletions.
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

0 comments on commit fc9ed8c

Please sign in to comment.