调用DescribeSnapshots查询一台ECS实例或一块云盘所有的快照列表。
接口说明
InstanceId
、DiskId
和SnapshotIds
不是必需的请求参数,但是可以构建过滤器逻辑,参数之间为逻辑与(And)关系。
通过阿里云CLI调用API时,不同数据类型的请求参数取值必须遵循一定的格式要求,详情请参见CLI参数格式说明。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeSnapshots |
系统规定参数。取值:DescribeSnapshots |
RegionId | String | 是 | cn-hangzhou |
云盘所属于的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。 |
InstanceId | String | 否 | i-bp67acfmxazb4p**** |
指定的实例ID。 |
DiskId | String | 否 | d-bp67acfmxazb4p**** |
指定的云盘设备ID。 |
SnapshotLinkId | String | 否 | sp-bp67acfmxazb4p**** |
快照链ID。 |
SnapshotIds | String | 否 | ["s-bp67acfmxazb4p****", "s-bp67acfmxazb5p****", … "s-bp67acfmxazb6p****"] |
快照标识编码。取值可以由多个快照ID组成一个JSON数组,最多支持100个ID,ID之间用半角逗号(,)隔开。 |
PageNumber | Integer | 否 | 1 |
快照列表的页码。起始值:1 默认值:1 |
PageSize | Integer | 否 | 10 |
分页查询时设置的每页行数。最大值:100 默认值:10 |
NextToken | String | 否 | caeba0bbb2be03f84eb48b699f0a4883 |
查询起始标志。由上一次的请求结果中获取。 |
MaxResults | Integer | 否 | 10 |
分页查询时每页行数。 最大值:100 默认值:10 |
SnapshotName | String | 否 | testSnapshotName |
快照名称。 |
Status | String | 否 | all |
快照状态。取值范围:
|
SnapshotType | String | 否 | all |
快照创建类型。取值范围:
|
Filter.1.Key | String | 否 | CreationStartTime |
查询资源时的筛选键。取值必须为CreationStartTime。 |
Filter.2.Key | String | 否 | CreationEndTime |
查询资源时的筛选键。取值必须为CreationEndTime。 |
Filter.1.Value | String | 否 | 2019-12-13T17:00Z |
查询资源时的筛选值。取值必须为资源创建的开始时间(CreationStartTime)的取值。 |
Filter.2.Value | String | 否 | 2019-12-13T22:00Z |
查询资源时的筛选值。取值必须为资源创建的结束时间(CreationEndTime)的取值。 |
Usage | String | 否 | none |
快照是否被用作创建镜像或云盘。取值范围:
|
SourceDiskType | String | 否 | Data |
快照源云盘的云盘类型。取值范围:
说明 取值不区分大小写。
|
Tag.N.Key | String | 否 | TestKey |
快照的标签键。N的取值范围:1~20 使用一个标签过滤资源,查询到该标签下的资源数量不能超过1000个;使用多个标签过滤资源,查询到同时绑定了多个标签的资源数量不能超过1000个。如果资源数量超过1000个,请使用ListTagResources接口进行查询。 |
Tag.N.Value | String | 否 | TestValue |
快照的标签值。N的取值范围:1~20 |
Encrypted | Boolean | 否 | false |
是否过滤加密快照。默认值:false |
ResourceGroupId | String | 否 | rg-bp67acfmxazb4p**** |
资源组ID。使用该参数过滤资源时,资源数量不能超过1000个。 |
DryRun | Boolean | 否 | false |
是否只预检此次请求。
|
KMSKeyId | String | 否 | 0e478b7a-4262-4802-b8cb-00d3fb40**** |
数据盘对应的KMS密钥ID。 |
Category | String | 否 | Standard |
快照类型。取值范围:
原本地快照更替为快照极速可用功能。该参数说明如下:
更多信息,请参见12月14日阿里云快照服务升级与新增计费项通知。 说明 该参数即将被弃用,为提高兼容性,建议您尽量使用其他参数。
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
NextToken | String | caeba0bbb2be03f84eb48b699f0a4883 |
下一个查询起始标志。 |
PageNumber | Integer | 1 |
快照列表的页码。 |
PageSize | Integer | 10 |
输入时设置的每页行数。 |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
请求ID。 |
Snapshots | Array of Snapshot |
快照详情集合。 |
|
Snapshot | |||
Category | String | standard |
快照类型。 说明 该参数即将被弃用,为提高兼容性,建议您尽量使用参数
InstantAccess 。
|
CreationTime | String | 2020-08-20T14:52:28Z |
创建时间。按照ISO8601标准表示,并使用UTC +0时间,格式为yyyy-MM-ddTHH:mm:ssZ。 |
Description | String | testDescription |
描述信息。 |
Encrypted | Boolean | false |
该快照是否加密。 |
InstantAccess | Boolean | false |
是否开启了快照极速可用功能。可能值:
|
InstantAccessRetentionDays | Integer | 30 |
设置快照极速可用功能的保留时间,保留时间到期后快照将自动释放。 默认与参数 |
KMSKeyId | String | 0e478b7a-4262-4802-b8cb-00d3fb40**** |
数据盘对应的KMS密钥ID。 |
LastModifiedTime | String | 2020-08-25T14:18:09Z |
快照的最后变更时间。按照ISO8601标准表示,并使用UTC +0时间,格式为yyyy-MM-ddTHH:mm:ssZ。 |
ProductCode | String | jxsc000**** |
从镜像市场继承的产品编号。 |
Progress | String | 100% |
快照创建进度,单位为百分比。 |
RemainTime | Integer | 38 |
正在创建的快照剩余完成时间,单位为秒。 |
ResourceGroupId | String | rg-bp67acfmxazb4p**** |
资源组ID。 |
RetentionDays | Integer | 30 |
自动快照保留天数。 |
SnapshotId | String | s-bp67acfmxazb4p**** |
快照ID。 |
SnapshotName | String | testSnapshotName |
快照显示名称。如果创建时指定了快照显示名称,则返回。 |
SnapshotSN | String | 64472-116742336-61976**** |
快照序列号。 |
SnapshotType | String | all |
快照创建类型。可能值:
|
SourceDiskId | String | d-bp67acfmxazb4ph**** |
源云盘ID。如果快照的源云盘已经被释放,该字段仍旧保留。 |
SourceDiskSize | String | 40 |
源云盘容量,单位:GiB。 |
SourceDiskType | String | system |
源云盘属性。可能值:
|
SourceStorageType | String | disk |
原云盘类型。 说明 该参数即将被弃用,为提高兼容性,建议您尽量使用其他参数。
|
Status | String | accomplished |
快照状态。可能值:
|
Tags | Array of Tag |
标签。 |
|
Tag | |||
TagKey | String | TestKey |
快照的标签键。 |
TagValue | String | TestValue |
快照的标签值。 |
Usage | String | image |
快照是否被用作创建镜像或云盘。可能值:
|
TotalCount | Integer | 1 |
快照总个数。 |
示例
请求示例
https://ecs.aliyuncs.com/?Action=DescribeSnapshots
&RegionId=cn-hangzhou
&InstanceId=i-bp67acfmxazb4p****
&DiskId=d-bp67acfmxazb4p****
&SnapshotIds=["s-bp67acfmxazb4p****", "s-bp67acfmxazb5p****", … "s-bp67acfmxazb6p****"]
&PageNumber=1
&PageSize=10
&SnapshotName=testSnapshotName
&Status=all
&SnapshotType=all
&Usage=none
&SourceDiskType=Data
&Tag.1.Key=TestKey
&Tag.1.Value=TestValue
&Encrypted=false
&DryRun=false
&<公共请求参数>
正常返回示例
XML
格式
<DescribeSnapshotsResponse>
<TotalCount>1</TotalCount>
<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
<PageSize>10</PageSize>
<NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
<PageNumber>1</PageNumber>
<Snapshots>
<Snapshot>
<Status>accomplished</Status>
<InstantAccess>false</InstantAccess>
<Progress>100%</Progress>
<Usage>image</Usage>
<Description>testDescription</Description>
<Category>standard</Category>
<KMSKeyId>0e478b7a-4262-4802-b8cb-00d3fb40****</KMSKeyId>
<ProductCode>jxsc000****</ProductCode>
<Encrypted>false</Encrypted>
<SnapshotName>testSnapshotName</SnapshotName>
<SourceDiskId>d-bp67acfmxazb4ph****</SourceDiskId>
<SourceStorageType>disk</SourceStorageType>
<SnapshotId>s-bp67acfmxazb4p****</SnapshotId>
<SnapshotSN>64472-116742336-61976****</SnapshotSN>
<SourceDiskSize>40</SourceDiskSize>
<CreationTime>2020-08-20T14:52:28Z</CreationTime>
<LastModifiedTime>2020-08-25T14:18:09Z</LastModifiedTime>
<SnapshotType>all</SnapshotType>
<SourceDiskType>system</SourceDiskType>
<Tags>
</Tags>
</Snapshot>
</Snapshots>
</DescribeSnapshotsResponse>
JSON
格式
{
"TotalCount": 1,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"PageSize": 10,
"NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
"PageNumber": 1,
"Snapshots": {
"Snapshot": [
{
"Status": "accomplished",
"InstantAccess": false,
"Progress": "100%",
"Usage": "image",
"Description": "testDescription",
"Category": "standard",
"KMSKeyId": "0e478b7a-4262-4802-b8cb-00d3fb40****",
"ProductCode": "jxsc000****",
"Encrypted": false,
"SnapshotName": "testSnapshotName",
"SourceDiskId": "d-bp67acfmxazb4ph****",
"SourceStorageType": "disk",
"SnapshotId": "s-bp67acfmxazb4p****",
"SnapshotSN": "64472-116742336-61976****",
"SourceDiskSize": 40,
"CreationTime": "2020-08-20T14:52:28Z",
"LastModifiedTime": "2020-08-25T14:18:09Z",
"SnapshotType": "all",
"SourceDiskType": "system",
"Tags": {
"Tag": []
}
}
]
}
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
403 | InvalidSnapshotIds.Malformed | The amount of specified specified snapshot Ids exceeds the limit. | 快照ID参数格式不正确。 |
404 | InvalidFilterKey.NotFound | 指定的起始时间或到期时间参数错误。 | |
404 | InvalidUsage | The specifed Usage is not valid | 指定有引用关系的资源类型(image、disk、image_disk、none)不合法。 |
404 | InvalidSourceDiskType | The specifed SourceDiskType is not valid | 指定的快照源磁盘的磁盘类型不合法。 |
404 | InvalidStatus.NotFound | The specified Status is not found | 指定的资源状态不存在。 |
404 | InvalidSnapshotType.NotFound | The specfied SnapshotType is not found | 指定的快照类型不存在。 |
400 | InvalidTag.Mismatch | The specified Tag.n.Key and Tag.n.Value are not match. | 指定的Tag.N.Key和Tag.N.Value不匹配。 |
400 | InvalidTagCount | The specified tags are beyond the permitted range. | 指定的标记超出取值范围。 |
500 | InternalError | The request processing has failed due to some unknown error. | 内部错误,请重试。如果多次尝试失败,请提交工单。 |
404 | InvalidSnapshotLinkId.NotFound | The specified snapshot link is not found. | 指定的快照链不存在。 |
403 | InvalidSnapshotCategory.Malformed | The specified Category is not valid. | 指定的快照类型无效。请检查Category参数值是否正确。 |
访问错误中心查看更多错误码。