Get the snapshot status Added in 7.8.0
Get a detailed description of the current state for each shard participating in the snapshot.
Note that this API should be used only 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.
If you omit the <snapshot>
request path parameter, the request retrieves information only for currently running snapshots.
This usage is preferred.
If needed, you can specify <repository>
and <snapshot>
to retrieve information for specific snapshots, even if they're not currently running.
WARNING: Using the API to return the status of any snapshots other than currently running snapshots can be expensive. The API requires a read from the repository for each shard in each snapshot. For example, if you have 100 snapshots with 1,000 shards each, an API request that includes all snapshots will require 100,000 reads (100 snapshots x 1,000 shards).
Depending on the latency of your storage, such requests can take an extremely long time to return results. These requests can also tax machine resources and, when using cloud storage, incur high processing costs.
Path parameters
-
The snapshot repository name used to limit the request. It supports wildcards (
*
) if<snapshot>
isn't specified. -
A comma-separated list of snapshots to retrieve status for. The default is currently running snapshots. Wildcards (
*
) are not supported.
Query parameters
-
master_timeout string
The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to
-1
.
curl \
--request GET http://api.example.com/_snapshot/{repository}/{snapshot}/_status
{
"snapshots": [
{
"include_global_state": true,
"indices": {
"additionalProperty1": {
"shards": {
"additionalProperty1": {},
"additionalProperty2": {}
},
"shards_stats": {
"done": 42.0,
"failed": 42.0,
"finalizing": 42.0,
"initializing": 42.0,
"started": 42.0,
"total": 42.0
},
"stats": {
"incremental": {},
"time": "string",
"total": {}
}
},
"additionalProperty2": {
"shards": {
"additionalProperty1": {},
"additionalProperty2": {}
},
"shards_stats": {
"done": 42.0,
"failed": 42.0,
"finalizing": 42.0,
"initializing": 42.0,
"started": 42.0,
"total": 42.0
},
"stats": {
"incremental": {},
"time": "string",
"total": {}
}
}
},
"repository": "string",
"shards_stats": {
"done": 42.0,
"failed": 42.0,
"finalizing": 42.0,
"initializing": 42.0,
"started": 42.0,
"total": 42.0
},
"snapshot": "string",
"state": "string",
"stats": {
"incremental": {
"file_count": 42.0,
"size_in_bytes": 42.0
},
"": 42.0,
"time": "string",
"total": {
"file_count": 42.0,
"size_in_bytes": 42.0
}
},
"uuid": "string"
}
]
}