Get snapshot status API

Retrieves a detailed description of the current state for each shard participating in the snapshot.

  1. GET /_snapshot/my_repository/my_snapshot/_status

Request

GET /_snapshot/<repository>/<snapshot>/_status

Description

Use the get snapshot status API to retrieve detailed information about snapshots currently running in the cluster.

If you specify both the repository name and snapshot, the request retrieves detailed status information for the given snapshot, even if not currently running.

Using the get snapshot status API to return any status results other than the currently running snapshots (_current) can be very expensive. Each request to retrieve snapshot status results in file reads from every shard in a snapshot, for each snapshot. Such requests are taxing to machine resources and can also incur high processing costs when running in the cloud.

For example, if you have 100 snapshots with 1,000 shards each, the API request will result in 100,000 file reads (100 snapshots * 1,000 shards). Depending on the latency of your file storage, the request can take extremely long to retrieve results.

Path parameters

<repository>

(Required, string) Snapshot repository name used to limit the request. Wildcard (*) expressions are supported.

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.

<snapshot>

(Required, string) Comma-separated list of snapshot names to retrieve status for.

To retrieve a list of all snapshots in a specified repository, omit this parameter.

Wildcard (*) expressions are not supported for <snapshot>.

Request body

ignore_unavailable

(Optional, boolean) If false, the request returns an error for any snapshots that are unavailable. Defaults to false.

If true, the request ignores snapshots that are unavailable, such as those that are corrupted or temporarily cannot be returned.

Response body

repository

(string) Name of the repository that includes the snapshot.

snapshot

(string) Name of the snapshot.

uuid

(string) Universally unique identifier (UUID) of the snapshot.

state

(string) Indicates the current snapshot state.

Values for state

  • FAILED

    The snapshot finished with an error and failed to store any data.

    IN_PROGRESS

    The snapshot is currently running.

    PARTIAL

    The global cluster state was stored, but data of at least one shard was not stored successfully. The failures section of the response contains more detailed information about shards that were not processed correctly.

    SUCCESS

    The snapshot finished and all shards were stored successfully.

include_global_state

(boolean) Indicates whether the current cluster state is included in the snapshot.

shards_stats

(object) Contains a count of shards in the snapshot.

Properties of shards_stats

  • initializing

    (integer) Number of shards that are still initializing.

    started

    (integer) Number of shards that have started but not are not finalized.

    finalizing

    (integer) Number of shards that are finalizing but are not done.

    done

    (integer) Number of shards that initialized, started, and finalized successfully.

    failed

    (integer) Number of shards that failed to be included in the snapshot.

    total

    (integer) Total number of shards included in the snapshot.

stats

(object) Provides details on the number (file_count) and size (size_in_bytes) of files included in the snapshot.

Properties of stats

  • incremental

    (object) Number and size of files that still need to be copied as part of the incremental snapshot.

    For completed snapshots, this property indicates the number and size of files that were not already in the repository and were copied as part of the incremental snapshot.

    processed

    (object) Number and size of files that have already been uploaded to the snapshot. After a file is uploaded, the processed file_count and size_in_bytes are incremented in stats.

    total

    (object) Total number and size of files that are referenced by the snapshot.

  • start_time_in_millis

    (long) The time, in milliseconds, when the snapshot creation process started.

  • time_in_millis

    (long) The total time, in milliseconds, that it took for the snapshot process to complete.

<index>

(list of objects) List of objects containing information about the indices included in the snapshot.

Properties of <index>

  • shards_stats

    (object) See shards_stats.

    stats

    (object) See stats.

    shards

    (list of objects) List of objects containing information about the shards that include the snapshot.

    Properties of shards

    • stage

      (string) Indicates the current state of the shards that include the snapshot.

      Properties of stage

      DONE

      Number of shards in the snapshot that were successfully stored in the repository.

      FAILURE

      Number of shards in the snapshot that were not successfully stored in the repository.

      FINALIZE

      Number of shards in the snapshot that are in the finalizing stage of being stored in the repository.

      INIT

      Number of shards in the snapshot that are in the initializing stage of being stored in the repository.

      STARTED

      Number of shards in the snapshot that are in the started stage of being stored in the repository.

      stats

      (object) See stats.

      total

      (object) Total number and size of files that are referenced by the snapshot.

      start_time_in_millis

      (long) See start_time_in_millis.

      time_in_millis

      (long) See time_in_millis.

Example

The following request returns detailed status information for snapshot_2 in the my_repository repository. This response includes additional information beyond the Get snapshot API, such as shard status and file statistics.

  1. GET /_snapshot/my_repository/snapshot_2/_status
  1. {
  2.   "snapshots" : [
  3.     {
  4.       "snapshot" : "snapshot_2",
  5.       "repository" : "my_repository",
  6.       "uuid" : "lNeQD1SvTQCqqJUMQSwmGg",
  7.       "state" : "SUCCESS",
  8.       "include_global_state" : false,
  9.       "shards_stats" : {
  10.         "initializing" : 0,
  11.         "started" : 0,
  12.         "finalizing" : 0,
  13.         "done" : 1,
  14.         "failed" : 0,
  15.         "total" : 1
  16.       },
  17.       "stats" : {
  18.         "incremental" : {
  19.           "file_count" : 3,
  20.           "size_in_bytes" : 5969
  21.         },
  22.         "total" : {
  23.           "file_count" : 4,
  24.           "size_in_bytes" : 6024
  25.         },
  26.         "start_time_in_millis" : 1594829326691,
  27.         "time_in_millis" : 205
  28.       },
  29.       "indices" : {
  30.         "index_1" : {
  31.           "shards_stats" : {
  32.             "initializing" : 0,
  33.             "started" : 0,
  34.             "finalizing" : 0,
  35.             "done" : 1,
  36.             "failed" : 0,
  37.             "total" : 1
  38.           },
  39.           "stats" : {
  40.             "incremental" : {
  41.               "file_count" : 3,
  42.               "size_in_bytes" : 5969
  43.             },
  44.             "total" : {
  45.               "file_count" : 4,
  46.               "size_in_bytes" : 6024
  47.             },
  48.             "start_time_in_millis" : 1594829326896,
  49.             "time_in_millis" : 0
  50.           },
  51.           "shards" : {
  52.             "0" : {
  53.               "stage" : "DONE",
  54.               "stats" : {
  55.                 "incremental" : {
  56.                   "file_count" : 3,
  57.                   "size_in_bytes" : 5969
  58.                 },
  59.                 "total" : {
  60.                   "file_count" : 4,
  61.                   "size_in_bytes" : 6024
  62.                 },
  63.                 "start_time_in_millis" : 1594829326896,
  64.                 "time_in_millis" : 0
  65.               }
  66.             }
  67.           }
  68.         }
  69.       }
  70.     }
  71.   ]
  72. }