DescribeSnapshots#

Description#

Request to get the list of available snapshots.

Request Parameters#

  • Filter.N — One or more filters.

    • Type: List of Filter objects

    • Required: No

  • Owner.N — Owners of volume snapshots.

    • Type: Array of strings

    • Valid values: self | k2 | <project_name>

    • Required: No

  • SnapshotId.N — IDs of volume snapshots.

    • Type: Array of strings

    • Required: No

  • RestorableBy.N — The projects, in which volumes can be created from snapshots.

    • Type: Array of strings

    • Valid values: self | all | <project_name>

    • Required: No

Supported Filters#

  • description — The description of the snapshot.

  • owner-alias — The alias of the snapshot owner (valid values — self, shared, k2).

  • “owner-id” — The ID of the account that owns the snapshot.

  • “snapshot-id” — The ID of the snapshot.

  • “start-time” — The timestamp when the snapshot was initiated.

  • status — The status of the snapshot (valid values — completed, deleted, error, pending).

  • tag-key — The tag key. Such a filter allows you to get resources with the specified key and any value.

  • tag:<tag-key> — The key/value a pair of a tag. The tag key is passed in the filter name, while the tag value is used as the filter value.

  • type — The type of the snapshot (valid values — backup, regular).

  • volume-id — The ID of the volume, from which the snapshot was created.

  • volume-size — The size of the snapshot, GiB.

Response Elements#

  • requestId — The request ID.

    • Type: String

  • snapshotSet — Information about the snapshots.

Examples#

c2-ec2 DescribeSnapshots

c2-ec2 DescribeSnapshots Owner.1 self

c2-ec2 DescribeSnapshots SnapshotId.1 snap-EC69832A

c2-ec2 DescribeSnapshots Filter.1.Name tag-key Filter.1.Value.1 some-key