You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[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)
Copy file name to clipboardExpand all lines: docs/reference/snapshot-restore/apis/get-snapshot-status-api.asciidoc
+20-15Lines changed: 20 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -73,39 +73,44 @@ PUT _snapshot/my_repository/snapshot_2?wait_for_completion=true
73
73
74
74
[source,console]
75
75
----
76
-
GET /_snapshot/my_repository/my_snapshot/_status
76
+
GET _snapshot/_status
77
77
----
78
78
79
79
[[get-snapshot-status-api-request]]
80
80
==== {api-request-title}
81
81
82
-
`GET /_snapshot/<repository>/<snapshot>/_status`
82
+
`GET _snapshot/_status`
83
+
84
+
`GET _snapshot/<repository>/_status`
85
+
86
+
`GET _snapshot/<repository>/<snapshot>/_status`
83
87
84
88
[[get-snapshot-status-api-desc]]
85
89
==== {api-description-title}
86
90
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.
88
96
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.
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.
101
109
102
110
`<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.
109
114
110
115
[role="child_attributes"]
111
116
[[get-snapshot-status-api-request-body]]
@@ -305,7 +310,7 @@ The following request returns detailed status information for `snapshot_2` in th
0 commit comments