Get the snapshot status | Elasticsearch API documentation

Path parameters

repositorystring Required
The snapshot repository name used to limit the request. It supports wildcards (*) if <snapshot> isn't specified.

Query parameters

ignore_unavailableboolean
If false, the request returns an error for any snapshots that are unavailable. If true, the request ignores snapshots that are unavailable, such as those that are corrupted or temporarily cannot be returned.
master_timeoutstring
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.
Values are -1 or 0.

Responses

200 application/json
Hide response attribute Show response attribute object
- snapshotsarray[object] Required
  Hide snapshots attributes Show snapshots attributes object
  include_global_stateboolean Required
  Indicates whether the current cluster state is included in the snapshot.
  indicesobject Required
  Hide indices attribute Show indices attribute object
  *object Additional properties
  Hide * attributes Show * attributes object
  shardsobject Required
  Hide shards attribute Show shards attribute object
  *object Additional properties
  shards_statsobject Required
  Hide shards_stats attributes Show shards_stats attributes object
  donenumber Required
  The number of shards that initialized, started, and finalized successfully.
  failednumber Required
  The number of shards that failed to be included in the snapshot.
  finalizingnumber Required
  The number of shards that are finalizing but are not done.
  initializingnumber Required
  The number of shards that are still initializing.
  startednumber Required
  The number of shards that have started but are not finalized.
  totalnumber Required
  The total number of shards included in the snapshot.
  statsobject Required
  Hide stats attributes Show stats attributes object
  incrementalobject Required
  start_time_in_millis
  timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  time_in_millis
  totalobject Required
  repositorystring Required
  The name of the repository that includes the snapshot.
  shards_statsobject Required
  Hide shards_stats attributes Show shards_stats attributes object
  donenumber Required
  The number of shards that initialized, started, and finalized successfully.
  failednumber Required
  The number of shards that failed to be included in the snapshot.
  finalizingnumber Required
  The number of shards that are finalizing but are not done.
  initializingnumber Required
  The number of shards that are still initializing.
  startednumber Required
  The number of shards that have started but are not finalized.
  totalnumber Required
  The total number of shards included in the snapshot.
  snapshotstring Required
  The name of the snapshot.
  statestring Required
  The current snapshot state:
  FAILED: The snapshot finished with an error and failed to store any data.
  STARTED: The snapshot is currently running.
  SUCCESS: The snapshot completed.
  statsobject Required
  Hide stats attributes Show stats attributes object
  incrementalobject Required
  Hide incremental attributes Show incremental attributes object
  file_countnumber Required
  size_in_bytesnumber Required
  start_time_in_millisnumber
  Time unit for milliseconds
  timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  time_in_millisnumber
  Time unit for milliseconds
  totalobject Required
  Hide total attributes Show total attributes object
  file_countnumber Required
  size_in_bytesnumber Required
  uuidstring Required

GET /_snapshot/{repository}/_status

GET _snapshot/my_repository/snapshot_2/_status

resp = client.snapshot.status(
    repository="my_repository",
    snapshot="snapshot_2",
)

const response = await client.snapshot.status({
  repository: "my_repository",
  snapshot: "snapshot_2",
});

response = client.snapshot.status(
  repository: "my_repository",
  snapshot: "snapshot_2"
)

$resp = $client->snapshot()->status([
    "repository" => "my_repository",
    "snapshot" => "snapshot_2",
]);

curl -X GET -H "Authorization: ApiKey $ELASTIC_API_KEY" "$ELASTICSEARCH_URL/_snapshot/my_repository/snapshot_2/_status"

Response examples (200)

A successful response from `GET _snapshot/my_repository/snapshot_2/_status`. The response contains detailed status information for `snapshot_2` in the `my_repository` repository.

{
  "snapshots" : [
    {
      "snapshot" : "snapshot_2",
      "repository" : "my_repository",
      "uuid" : "lNeQD1SvTQCqqJUMQSwmGg",
      "state" : "SUCCESS",
      "include_global_state" : false,
      "shards_stats" : {
        "initializing" : 0,
        "started" : 0,
        "finalizing" : 0,
        "done" : 1,
        "failed" : 0,
        "total" : 1
      },
      "stats" : {
        "incremental" : {
          "file_count" : 3,
          "size_in_bytes" : 5969
        },
        "total" : {
          "file_count" : 4,
          "size_in_bytes" : 6024
        },
        "start_time_in_millis" : 1594829326691,
        "time_in_millis" : 205
      },
      "indices" : {
        "index_1" : {
          "shards_stats" : {
            "initializing" : 0,
            "started" : 0,
            "finalizing" : 0,
            "done" : 1,
            "failed" : 0,
            "total" : 1
          },
          "stats" : {
            "incremental" : {
              "file_count" : 3,
              "size_in_bytes" : 5969
            },
            "total" : {
              "file_count" : 4,
              "size_in_bytes" : 6024
            },
            "start_time_in_millis" : 1594829326896,
            "time_in_millis" : 0
          },
          "shards" : {
            "0" : {
              "stage" : "DONE",
              "stats" : {
                "incremental" : {
                  "file_count" : 3,
                  "size_in_bytes" : 5969
                },
                "total" : {
                  "file_count" : 4,
                  "size_in_bytes" : 6024
                },
                "start_time_in_millis" : 1594829326896,
                "time_in_millis" : 0
              }
            }
          }
        }
      }
    }
  ]
}