Call the DescribeSnapshots API to query the list of snapshots.

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

request parameters

Only request parameters specific to this API and some common parameters are listed below. For more information, see Common Parameters.

Action string required Example value: DescribeSnapshots

The action to be performed: DescribeSnapshots.

Version string required Example: 2020-04-01

The version of the API is: 2020-04-01.

PageSize integer Optional Example value: 10

Page size, default is 10.

PageNumber integer Optional Example: 1

Starting page, default is 1.

Filter.N.Value string[] Optional Example: testValue

Filter keys for querying resources. The value description is as follows:

CreationStartTime: Query information on resources created after the specified time.

CreationEndTime: Query information on resources created before the specified time.

Filter.N.Key string[] Optional Example: testkey

Filter value for querying resources. When specifying this parameter, you must also specify the Filter.N.Key parameter. The format is yyyy-MM-ddTHH:mmZ, using UTC +0 time zone.

ZoneId string Optional Example value: cn-beijing-a

Availability Zone ID.

SnapshotStatus.N string[] Optional Example value: available

Snapshot status. Value descriptions are as follows:

Available.

Creating: In process.

Rolling back.

Deleted: has been deleted.

Failed: Error.

SnapshotName string Optional Example: testSnapshotName

Snapshot name.

VolumeId string Optional Example: vol-bp1s5fnvk4gn2tws0****

Volume ID related to snapshot.

NextToken string Optional Example value: AAAAGQAAABpzbmFwLTN3Yml2eWNzOHcycnJ2dTFsMTljMjAyNS0wNC0yMyAwNDozNjowNC4xNDI5MTE=

Pagination token for the next page.

MaxResults integer Optional Example: 100

The maximum number of records returned per query is 100.

SnapshotTypes.N string[] Optional Example value: user

Description of snapshot types:

user: Query manual snapshots.

auto: Query automatic snapshots.

share: Query shared snapshots.

The default is to query all snapshots.

TagFilters.N.Key string[] Optional Example value: TagFilters.1.Key=tag

Specifying the tag key when querying resources by tags. Description as follows:

TagFilters.N.Key: N refers to the sequence number of the tag key. Value range: 1~10.

Separate multiple tag keys with &, and do not allow duplicates.

If this parameter is not provided, it implies querying all tags.

When an empty string is passed, the error code InvalidTagFilterKey.Malformed is returned.

TagFilters.N.Values.N string[] Optional Example: TagFilters.1.Values.1=tag&TagFilters.1.Values.2=test

Specifies the tag value when querying resources by tags. Description as follows:

TagFilters.N.Values.N: The first N indicates the index of the tag key. Value range: 1~10.

TagFilters.N.Values.N: The second N indicates the index of the tag value. Value range: 1 to 3.

Use & to separate multiple tag values.

If this parameter is passed in, you must first pass in TagFilters.N.Key.

Not providing this parameter means querying all tag values under the same tag key.

When an empty string is entered, it means querying tags with empty tag values.

SnapshotIds.N string[] Optional Example: snap-3tigy72q3u3vj0x2****

Snapshot IDs to query.

ProjectName string Optional Example value: default

Filter snapshots by the name of the project they belong to.

Response Parameters

Only response parameters specific to this API are listed below. For more information, see Response Structure.

PageSize integer Example: 10

Page Size.

PageNumber integer Example: 1

Page number.

TotalCount integer Example value: 1

Total number of snapshots.

Snapshots object[] Example value: -

Snapshot detail set.

SnapshotType string Example: auto

Description of snapshot types:

User: Manual snapshot.

Auto: Automatic snapshot.

Description string Example: test

Snapshot description information.

ZoneId string Example value: cn-beijing-a

Available zone ID. If the snapshot has ultra-fast availability enabled, you can create volumes from this snapshot in the corresponding available zone.

CreationTime string Example: 2021-12-12 03:33:04.374716

Snapshot creation time.

SnapshotName string Example: snapshotname

Snapshot name.

Status string Example value: creating

Snapshot status. Values are as follows:

Available.

Creating: In process.

Rolling back.

Deleted: has been deleted.

Failed: Error.

VolumeId string Example value: vol-bp1s5fnvk4gn2tws0****

Volume ID.

VolumeSize long Example: 20

Volume size, in GiB.

VolumeType string Example: TSSD_TL0

Cloud disk type, with the following values:

ESSD_PL0: High-speed SSD volume of PL0 specification.

ESSD_FlexPL: High-speed SSD volume of FlexPL specification.

TSSD_TL0: Throughput-type SSD volume

SnapshotId string Example: snap-3tigy72q3u3vj0x2****

Snapshot ID.

VolumeName string Example value: test

Cloud disk name.

ProjectName string Example value: default

Snapshot belongs to the project.

VolumeKind string Example value: system

Volume type. Value descriptions are as follows:

system: System disk.

data: Data disk.

VolumeStatus string Example value: attaching

Volume status, with values explained as follows:

available: Available

attaching: Attaching

attached: Attached

detaching: Detaching

creating: In creation

deleting: Deleting

error: Error

Extending: Expanding

RetentionDays integer Example: 3

Automatic snapshot retention days.

Progress integer Example: 20

Dump progress

SnapshotGroupId string Example: sg-3wrulg6iwi4p5d64****

Snapshot Consistency Group ID.

ImageId string Example: sg-3wrulg6iwi4p5d64****

Image ID.

Shared boolean Example value: true

Indicates whether the snapshot is shared with others.

True: the snapshot has been shared with others.

False: the snapshot has not been shared with others.

Tags object[] Example value: -

Tag information.

Key string Example: tag

Snapshot tag key.

Value string Example value: test

Snapshot Tag Value.

InstantAccess boolean Example: true

Indicates whether Instant Access is enabled for the snapshot. Description as follows:

true: Instant Access is enabled.

false: Turbo capability is not enabled.

Request example

Back to example

error code

The table below lists error codes related to this interface and business logic. For public error codes, see the public error code documentation.

Status code	error code	error message	Create Volume
400	InvalidRequest	The operation is not permitted due to the request is invalid.	Invalid request.
400	ErrInvalidAccountId	account id invalid	Account ID is invalid.
400	ErrMaximumTagFilterKeys	too many tag filter keys	The tag filter key exceeds the limit.
400	ErrTagFilterKeyConflict	tag filter key conflict	Tag filter key conflict.
400	ErrInvalidTagFilterKey	tag filter key invalid	Invalid tag filter key.
400	ErrMaximumTagFilterValues	too many tag filter value	Tag filter value exceeds the limit.
400	ErrInvalidTagFilterValue	tag filter value invalid	Invalid tag filter value.
400	SnapshotServiceNonactivated	Snapshot service is nonactivated, need activate snapshot service from user console.	Snapshot service is not enabled. Activate it in the user console.

Elastic Compute Service