Get snapshot information Added in 0.0.0
NOTE: The after
parameter and next
field enable you to iterate through snapshots with some consistency guarantees regarding concurrent creation or deletion of snapshots.
It is guaranteed that any snapshot that exists at the beginning of the iteration and is not concurrently deleted will be seen during the iteration.
Snapshots concurrently created may be seen during an iteration.
Path parameters
-
A comma-separated list of snapshot repository names used to limit the request. Wildcard (
*
) expressions are supported. -
A comma-separated list of snapshot names to retrieve Wildcards (
*
) are supported.- To get information about all snapshots in a registered repository, use a wildcard (
*
) or_all
. - To get information about any snapshots that are currently running, use
_current
.
- To get information about all snapshots in a registered repository, use a wildcard (
Query parameters
-
after string
An offset identifier to start pagination from as returned by the next field in the response body.
-
from_sort_value string
The value of the current sort column at which to start retrieval. It can be a string
snapshot-
or a repository name when sorting by snapshot or repository name. It can be a millisecond time value or a number when sorting byindex-
or shard count. -
index_details boolean
If
true
, the response includes additional information about each index in the snapshot comprising the number of shards in the index, the total size of the index in bytes, and the maximum number of segments per shard in the index. The default isfalse
, meaning that this information is omitted. -
index_names boolean
If
true
, the response includes the name of each index in each snapshot. -
include_repository boolean
If
true
, the response includes the repository name in each snapshot. -
master_timeout string
The period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error.
-
order string
The sort order. Valid values are
asc
for ascending anddesc
for descending order. The default behavior is ascending order.Values are
asc
ordesc
. -
offset number
Numeric offset to start pagination from based on the snapshots matching this request. Using a non-zero value for this parameter is mutually exclusive with using the after parameter. Defaults to 0.
-
size number
The maximum number of snapshots to return. The default is 0, which means to return all that match the request without limit.
-
slm_policy_filter string
Filter snapshots by a comma-separated list of snapshot lifecycle management (SLM) policy names that snapshots belong to.
You can use wildcards (
*
) and combinations of wildcards followed by exclude patterns starting with-
. For example, the pattern*,-policy-a-\*
will return all snapshots except for those that were created by an SLM policy with a name starting withpolicy-a-
. Note that the wildcard pattern*
matches all snapshots created by an SLM policy but not those snapshots that were not created by an SLM policy. To include snapshots that were not created by an SLM policy, you can use the special pattern_none
that will match all snapshots without an SLM policy. -
sort string
The sort order for the result. The default behavior is sorting by snapshot start time stamp.
Values are
start_time
,duration
,name
,index_count
,repository
,shard_count
, orfailed_shard_count
. -
verbose boolean
If
true
, returns additional information about each snapshot such as the version of Elasticsearch which took the snapshot, the start and end times of the snapshot, and the number of shards snapshotted.NOTE: The parameters
size
,order
,after
,from_sort_value
,offset
,slm_policy_filter
, andsort
are not supported when you setverbose=false
and the sort order for requests withverbose=false
is undefined.
curl \
--request GET http://api.example.com/_snapshot/{repository}/{snapshot}
{
"remaining": 42.0,
"total": 42.0,
"next": "string",
"responses": [
{
"repository": "string",
"snapshots": [
{
"data_streams": [
"string"
],
"duration": "string",
"": 42.0,
"failures": [
{}
],
"include_global_state": true,
"indices": [
"string"
],
"index_details": {
"additionalProperty1": {},
"additionalProperty2": {}
},
"metadata": {
"additionalProperty1": {},
"additionalProperty2": {}
},
"reason": "string",
"repository": "string",
"snapshot": "string",
"shards": {
"failed": 42.0,
"successful": 42.0,
"total": 42.0,
"failures": [
{}
],
"skipped": 42.0
},
"state": "string",
"uuid": "string",
"version": "string",
"version_id": 42.0,
"feature_states": [
{}
]
}
],
"error": {
"type": "string",
"reason": "string",
"stack_trace": "string",
"caused_by": {},
"root_cause": [
{}
],
"suppressed": [
{}
]
}
}
],
"snapshots": [
{
"data_streams": [
"string"
],
"duration": "string",
"": 42.0,
"failures": [
{
"index": "string",
"node_id": "string",
"reason": "string",
"shard_id": "string",
"index_uuid": "string",
"status": "string"
}
],
"include_global_state": true,
"indices": [
"string"
],
"index_details": {
"additionalProperty1": {
"shard_count": 42.0,
"": 42.0,
"size_in_bytes": 42.0,
"max_segments_per_shard": 42.0
},
"additionalProperty2": {
"shard_count": 42.0,
"": 42.0,
"size_in_bytes": 42.0,
"max_segments_per_shard": 42.0
}
},
"metadata": {
"additionalProperty1": {},
"additionalProperty2": {}
},
"reason": "string",
"repository": "string",
"snapshot": "string",
"shards": {
"failed": 42.0,
"successful": 42.0,
"total": 42.0,
"failures": [
{
"index": "string",
"node": "string",
"reason": {},
"shard": 42.0,
"status": "string"
}
],
"skipped": 42.0
},
"state": "string",
"uuid": "string",
"version": "string",
"version_id": 42.0,
"feature_states": [
{
"feature_name": "string",
"indices": "string"
}
]
}
]
}