Get the snapshot status | Elasticsearch API documentation (original) (raw)

Dismiss highlight Show more

Path parameters

• The snapshot repository name used to limit the request. It supports wildcards (*) if <snapshot> isn't specified.
• snapshot
  string | array[string] Required
  A comma-separated list of snapshots to retrieve status for. The default is currently running snapshots. Wildcards (*) are not supported.

Query parameters

• 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.
• 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.

Responses

• 200 application/json
  Hide response attribute Show response attribute object
  • Hide snapshots attributes Show snapshots attributes object
    * Indicates whether the current cluster state is included in the snapshot.
    * Hide indices attribute Show indices attribute object
    * *
    object Additional properties
    Hide * attributes Show * attributes object
    * Hide shards attribute Show shards attribute object
    * *
    object Additional properties
    * Hide shards_stats attributes Show shards_stats attributes object
    * The number of shards that initialized, started, and finalized successfully.
    * The number of shards that failed to be included in the snapshot.
    * The number of shards that are finalizing but are not done.
    * The number of shards that are still initializing.
    * The number of shards that have started but are not finalized.
    * The total number of shards included in the snapshot.
    * Hide stats attributes Show stats attributes object
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * The name of the repository that includes the snapshot.
    * Hide shards_stats attributes Show shards_stats attributes object
    * The number of shards that initialized, started, and finalized successfully.
    * The number of shards that failed to be included in the snapshot.
    * The number of shards that are finalizing but are not done.
    * The number of shards that are still initializing.
    * The number of shards that have started but are not finalized.
    * The total number of shards included in the snapshot.
    * The name of the snapshot.
    * 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.
    * Hide stats attributes Show stats attributes object
    * Hide incremental attributes Show incremental attributes object
    * Time unit for milliseconds
    * A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) andd (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
    * Time unit for milliseconds
    * Hide total attributes Show total attributes object