Skip to content

Commit ea06815

Browse files
authored
[DOCS] Fix get snapshot status API parameters (#81818) (#83470)
* Documents `GET _snapshot/_status` and `GET _snapshot/<repository>/_status`. * Notes the `<repository>` and `<snasphot>` parameters are optional. * Removes erroneous mention of the `<snapshot>` parameter supporting the `_current` value. Closes #81600 Relates to #80931 (cherry picked from commit 88be4ed)
1 parent f76f9a6 commit ea06815

File tree

1 file changed

+20
-15
lines changed

1 file changed

+20
-15
lines changed

docs/reference/snapshot-restore/apis/get-snapshot-status-api.asciidoc

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -73,39 +73,44 @@ PUT _snapshot/my_repository/snapshot_2?wait_for_completion=true
7373

7474
[source,console]
7575
----
76-
GET /_snapshot/my_repository/my_snapshot/_status
76+
GET _snapshot/_status
7777
----
7878

7979
[[get-snapshot-status-api-request]]
8080
==== {api-request-title}
8181

82-
`GET /_snapshot/<repository>/<snapshot>/_status`
82+
`GET _snapshot/_status`
83+
84+
`GET _snapshot/<repository>/_status`
85+
86+
`GET _snapshot/<repository>/<snapshot>/_status`
8387

8488
[[get-snapshot-status-api-desc]]
8589
==== {api-description-title}
8690

87-
Use the get snapshot status API to retrieve detailed information about snapshots currently running in the cluster.
91+
Use the get snapshot status API to get detailed information about the shards
92+
participating in a snapshot.
93+
94+
If you omit the `<snapshot>` request path parameter, the request only retrieves
95+
information for currently running snapshots. This usage is preferred.
8896

89-
If you specify both the repository name and snapshot, the request retrieves detailed status information for the given snapshot, even if not currently running.
97+
If needed, you can specify `<repository>` and `<snapshot>` to retrieve
98+
information for specific snapshots, even if they're not currently running.
9099

91100
include::{es-ref-dir}/snapshot-restore/monitor-snapshot-restore.asciidoc[tag=get-snapshot-status-warning]
92101

93102
[[get-snapshot-status-api-path-params]]
94103
==== {api-path-parms-title}
95104

96105
`<repository>`::
97-
(Required, string)
98-
Snapshot repository name used to limit the request. Wildcard (`*`) expressions are supported.
99-
+
100-
Use `_current` after the repository name to limit the request only to the currently running snapshots. This usage is preferred to return only snapshots that are currently running and not degrade response time.
106+
(Optional, string)
107+
Snapshot repository name used to limit the request. Supports wildcards (`*`) if
108+
`<snapshot>` isn't specified.
101109

102110
`<snapshot>`::
103-
(Required, string)
104-
Comma-separated list of snapshot names to retrieve status for.
105-
+
106-
To retrieve a list of all snapshots in a specified repository, omit this parameter.
107-
+
108-
NOTE: Wildcard (`*`) expressions are not supported for `<snapshot>`.
111+
(Optional, string)
112+
Comma-separated list of snapshots to retrieve status for. Defaults to
113+
currently running snapshots. Wildcards (`*`) are not supported.
109114

110115
[role="child_attributes"]
111116
[[get-snapshot-status-api-request-body]]
@@ -305,7 +310,7 @@ The following request returns detailed status information for `snapshot_2` in th
305310

306311
[source,console]
307312
----
308-
GET /_snapshot/my_repository/snapshot_2/_status
313+
GET _snapshot/my_repository/snapshot_2/_status
309314
----
310315

311316
[source,console-result]

0 commit comments

Comments
 (0)