全部产品
云服务器 ECS

DescribeSnapshots

更新时间:2017-09-13 12:57:05   分享:   

描述

查询某个 ECS 实例磁盘设备所有的快照列表。

InstanceIdDiskIdSnapshotIds 不再作为必选参数,而是作为 Filter 进行使用,为逻辑与(And)关系。

请求参数

名称 类型 是否必须 描述
Action String 系统规定参数。取值:DescribeSnapshots
Encrypted Boolean 过滤加密快照。取值范围:
  • true:只筛选出加密快照
  • false:不做加密属性的筛选
默认值:False
RegionId String 磁盘所属于的 Region ID。
InstanceId String 指定的实例 ID。
DiskId String 指定的磁盘设备 ID。
SnapshotIds String 快照标识编码。一个带有格式的 Json Array:[“s-xxxxxxxxx”, ”s-yyyyyyyyy”, … “s-zzzzzzzzz”],最多 100 个 ID,用半角逗号字符隔开。
SnapshotName String 快照名称。
Status String 快照状态。取值范围:
  • progressing
  • accomplished
  • failed
  • all
默认值:all
SnapshotType String 快照类型。取值范围:
  • auto
  • user
  • all
默认值:all
SourceDiskType String 快照源磁盘的磁盘类型。取值范围:
  • System
  • Data
Usage String 有引用关系的资源类型。取值范围:
  • image
  • disk
  • image_disk
  • none
Tag.n.Key String 标签键,n 从 1 开始,最大为 5。不允许为空字符串。
Tag.n.Value String 标签值,n 从 1 开始,最大为 5。允许为空字符串。
PageNumber Integer 磁盘状态列表的页码,起始值为 1。
默认值:1
PageSize Integer 分页查询时设置的每页行数,最大值 100 行。
默认值:10

返回参数

名称 类型 描述
TotalCount Integer 快照总个数
PageNumber Integer 快照列表的页码
PageSize Integer 输入时设置的每页行数
Snapshots SnapshotType 快照详情 SnapshotType 组成的集合

错误码

错误代码 描述 Http 状态码 语义
InvalidSnapshotIds.Malformed The amount of specified specified snapshot Ids exceeds the limit. 403 SnapshotIds 参数格式不正确。
InvalidStatus.NotFound The specified Status is not found. 404 指定的 Status 不存在。
InvalidSnapshotType.NotFound The specfied SnapshotType is not found. 404 指定的 SnapshotType 不存在。
InvalidUsage The specifed Usage is not valid. 404 指定的 Usage 不合法。
InvalidSourceDiskType The specifed SourceDiskType is not valid. 404 SourceDiskType 不合法。
InvalidTag.Mismatch The specified Tag.n.Key and Tag.n.Value are not match. 400 指定的 Tag.n.Key 和 Tag.n.Value 不匹配。
InvalidTagCount The specified tags are beyond the permitted range. 400 指定的 Tag 数超过了 5 个。

示例

请求示例

  1. https://ecs.aliyuncs.com/?Action=DescribeSnapshots
  2. &RegionId=cn-hangzhou
  3. &<公共请求参数>

返回示例

XML格式

  1. <DescribeSnapshotsResponse>
  2. <Snapshots>
  3. <Snapshot>
  4. <CreationTime>2014-07-24T13:00:52Z</CreationTime>
  5. <Description></Description>
  6. <SourceDiskId>d-23x0r79qy</SourceDiskId>
  7. <SourceDiskType>DATA</SourceDiskType>
  8. <ProductCode></ProductCode>
  9. <SnapshotName>auto_20140724_2</SnapshotName>
  10. <Progress>100%</Progress>
  11. <SourceDiskSize>50</SourceDiskSize>
  12. <Status>accomplished</Status>
  13. <SnapshotId>s-23f2i9s4t</SnapshotId>
  14. <Usage>none</Usage>
  15. </Snapshot>
  16. <Snapshot>
  17. <CreationTime>2014-07-24T13:00:42Z</CreationTime>
  18. <Description></Description>
  19. <SourceDiskId>101-70105379</SourceDiskId>
  20. <SourceDiskType>DATA</SourceDiskType>
  21. <ProductCode></ProductCode>
  22. <SnapshotName>auto_20140724_2</SnapshotName>
  23. <Progress>100%</Progress>
  24. <SourceDiskSize>5</SourceDiskSize>
  25. <Status>accomplished</Status>
  26. <SnapshotId>s-23izto5qm</SnapshotId>
  27. <Usage>none</Usage>
  28. </Snapshot>
  29. </Snapshots>
  30. <PageNumber>1</PageNumber>
  31. <PageSize>2</PageSize>
  32. <TotalCount>36</TotalCount>
  33. <RequestId>2F409D67-329A-4405-B924-2FC28566B366</RequestId>
  34. </DescribeSnapshotsResponse>

JSON格式

  1. {
  2. "PageNumber": 1,
  3. "PageSize": 2,
  4. "RequestId": "659F91C6-1949-43B0-90C4-B6342CA757D5",
  5. "Snapshots": {
  6. "Snapshot": [
  7. {
  8. "CreationTime": "2015-07-30T05:00:14Z",
  9. "Progress": "100%",
  10. "SnapshotId": "s-943ypfgic",
  11. "SnapshotName": "auto_20150730_3",
  12. "SourceDiskId": "d-944qyqjfa",
  13. "SourceDiskSize": 20,
  14. "SourceDiskType": "system",
  15. "Status": "accomplished",
  16. "Usage": "none"
  17. },
  18. {
  19. "CreationTime": "2015-07-30T05:00:14Z",
  20. "Progress": "100%",
  21. "SnapshotId": "s-94osg320e",
  22. "SnapshotName": "auto_20150730_3",
  23. "SourceDiskId": "d-94j355jsq",
  24. "SourceDiskSize": 20,
  25. "SourceDiskType": "system",
  26. "Status": "accomplished",
  27. "Usage": "none"
  28. }
  29. ]
  30. },
  31. "TotalCount": 36
  32. }
本文导读目录
本文导读目录
以上内容是否对您有帮助?