调用DescribeSnapshots接口查询快照列表。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下方仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Action string 必选示例值：DescribeSnapshots

要执行的操作，取值：DescribeSnapshots。

Version string 必选示例值：2020-04-01

API的版本，取值：2020-04-01。

PageSize integer 可选示例值：10

每页大小，默认为10。

PageNumber integer 可选示例值：1

起始页，默认为1。

Filter.N.Value string[] 可选示例值：testValue

查询资源时的筛选键，取值说明如下：

CreationStartTime：查询在指定时间点后创建的资源信息。

CreationEndTime：查询在指定时间点前创建的资源信息。

Filter.N.Key string[] 可选示例值：testkey

查询资源时的筛选值。指定该参数时必须同时指定Filter.N.Key参数，格式为：yyyy-MM-ddTHH:mmZ，采用UTC +0时区。

ZoneId string 可选示例值：cn-beijing-a

可用区ID。

SnapshotStatus.N string[] 可选示例值：available

快照状态，取值说明如下：

available：可用。

creating：创建中。

rollbacking：回滚中。

deleted：已删除。

failed：错误。

SnapshotName string 可选示例值：testSnapshotName

快照名称。

VolumeId string 可选示例值：vol-bp1s5fnvk4gn2tws0****

快照相关的云盘ID。

NextToken string 可选示例值：AAAAGQAAABpzbmFwLTN3Yml2eWNzOHcycnJ2dTFsMTljMjAyNS0wNC0yMyAwNDozNjowNC4xNDI5MTE=

下一页查询标识。

MaxResults integer 可选示例值：100

每次查询最多返回的记录总数，最大值为100。

SnapshotTypes.N string[] 可选示例值：user

快照类型，取值说明如下：

user：查询手动快照。

auto：查询自动快照。

share：查询共享快照。

默认查询所有快照。

TagFilters.N.Key string[] 可选示例值：TagFilters.1.Key=tag

根据标签查询资源时指定的标签键。说明如下：

TagFilters.N.Key：N表示标签键的序号。取值范围：1～10。

多个标签键之间用&分隔，不允许重复。

不传入该参数则表示查询所有标签。

传入空字符串时，则返回错误码InvalidTagFilterKey.Malformed。

TagFilters.N.Values.N string[] 可选示例值：TagFilters.1.Values.1=tag&TagFilters.1.Values.2=test

根据标签查询资源时指定的标签值。说明如下：

TagFilters.N.Values.N：第一个N表示标签键的序号。取值范围：1～10。

TagFilters.N.Values.N：第二个N表示标签值的序号。取值范围：1～3。

多个标签值之间用&分隔。

如果传入该参数，则必须先传入TagFilters.N.Key。

不传入该参数则表示查询同一标签键下的所有标签值。

传入空字符串时，表示查询标签值为空的标签。

SnapshotIds.N string[] 可选示例值：snap-3tigy72q3u3vj0x2****

待查询的快照ID。

ProjectName string 可选示例值：default

根据快照所属的Project（项目）名筛选快照。

返回参数

下方仅列出本接口特有的返回参数。更多信息请参见返回结构。

PageSize integer 示例值：10

每页大小。

PageNumber integer 示例值：1

页码。

TotalCount integer 示例值：1

快照总个数。

Snapshots object[] 示例值：-

快照详情集合。

SnapshotType string 示例值：auto

快照类型，取值说明如下：

user：手动快照。

auto：自动快照。

Description string 示例值：test

快照描述信息。

ZoneId string 示例值：cn-beijing-a

可用区 ID。如果该快照开启了极速可用能力，则您可以在该可用区通过极速可用快照创建云盘。

CreationTime string 示例值：2021-12-12 03:33:04.374716

快照创建时间。

SnapshotName string 示例值：snapshotname

快照的名称。

Status string 示例值：creating

快照状态，取值说明如下：

available：可用。

creating：创建中。

rollbacking：回滚中。

deleted：已删除。

failed：错误。

VolumeId string 示例值：vol-bp1s5fnvk4gn2tws0****

云盘ID。

VolumeSize long 示例值：20

云盘大小，单位为GiB。

VolumeType string 示例值：TSSD_TL0

云盘类型，取值说明如下：

ESSD_PL0：极速型SSD云盘，PL0规格。

ESSD_FlexPL：极速型SSD云盘，FlexPL规格。

TSSD_TL0：吞吐型SSD云盘

SnapshotId string 示例值：snap-3tigy72q3u3vj0x2****

快照ID。

VolumeName string 示例值：test

云盘名称。

ProjectName string 示例值：default

快照所属项目。

VolumeKind string 示例值：system

云盘种类，取值说明如下：

system：系统盘。

data：数据盘。

VolumeStatus string 示例值：attaching

云盘状态，取值说明如下：

available：可用

attaching：挂载中

attached：已挂载

detaching：卸载中

creating：创建中

deleting：删除中

error：错误

extending：扩容中

RetentionDays integer 示例值：3

自动快照保留天数。

Progress integer 示例值：20

转储进度

SnapshotGroupId string 示例值：sg-3wrulg6iwi4p5d64****

快照一致性组ID。

ImageId string 示例值：sg-3wrulg6iwi4p5d64****

镜像ID。

Shared boolean 示例值：true

快照是否被共享给他人，取值说明如下：

true：快照已共享给他人。

false：快照未被共享给他人。

Tags object[] 示例值：-

标签信息。

Key string 示例值：tag

快照的标签键。

Value string 示例值：test

快照的标签值。

InstantAccess boolean 示例值：true

快照是否开启极速可用能力，取值说明如下：

true：已开启极速可用能力。

false：未开启极速可用能力。

请求示例

返回示例

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidRequest	The operation is not permitted due to the request is invalid.	无效的请求。
400	ErrInvalidAccountId	account id invalid	账号ID无效。
400	ErrMaximumTagFilterKeys	too many tag filter keys	标签过滤键超出限制。
400	ErrTagFilterKeyConflict	tag filter key conflict	标签过滤器键冲突。
400	ErrInvalidTagFilterKey	tag filter key invalid	标签过滤键无效。
400	ErrMaximumTagFilterValues	too many tag filter value	标签过滤值超出限制。
400	ErrInvalidTagFilterValue	tag filter value invalid	标签过滤器值无效。
400	SnapshotServiceNonactivated	Snapshot service is nonactivated, need activate snapshot service from user console.	快照服务未开通，请从用户控制台进行开通。

云服务器