查询一台 ECS 实例或一块磁盘设备所有的快照列表。InstanceIdDiskIdSnapshotIds 不是必需参数,但是可以构建过滤器逻辑,参数之间为逻辑与(And)关系。

请求参数

名称 类型 是否必需 描述
Action String 系统规定参数。取值:DescribeSnapshots
RegionId String 磁盘所属于的 Region ID。
InstanceId String 指定的实例 ID。
DiskId String 指定的磁盘设备 ID。
Encrypted Boolean 过滤加密快照。取值范围:
  • true:只筛选出加密快照
  • false:不做加密属性的筛选
默认值:False
SnapshotIds String 快照标识编码。取值可以由多个快照 ID 组成一个 JSON 数组,格式为 ["s-xxxxxxxxx", "s-yyyyyyyyy", … "s-zzzzzzzzz"],最多支持 100 个 ID,ID 之间用半角逗号(,)隔开。
SnapshotName String 快照名称。
Status String 快照状态。取值范围:
  • progressing:正在创建的快照
  • accomplished:创建成功的快照
  • failed:创建失败的快照
  • all:所有快照状态
默认值:all
SnapshotType String 快照类型。取值范围:
  • auto:自动快照
  • user:手动创建的快照
  • all:所有快照类型
默认值:all
SourceDiskType String 快照源磁盘的磁盘类型。取值范围:
  • System:根据系统盘创建的快照
  • Data:根据数据盘创建的快照
Usage String 有引用关系的资源类型。取值范围:
  • image:使用快照 CreateImage
  • disk:使用快照 CreateDisk
  • 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 快照详情集合

示例

请求示例
https://ecs.aliyuncs.com/?Action=DescribeSnapshots
&RegionId=cn-hangzhou
&<公共请求参数>
返回示例

XML 格式

<DescribeSnapshotsResponse>
    <Snapshots>
        <Snapshot>
            <CreationTime>2014-07-24T13:00:52Z</CreationTime>
            <Description></Description>
            <SourceDiskId>d-23x0r79qy</SourceDiskId>
            <SourceDiskType>DATA</SourceDiskType>
            <ProductCode></ProductCode>
            <SnapshotName>auto_20140724_2</SnapshotName>
            <Progress>100%</Progress>
            <SourceDiskSize>50</SourceDiskSize>
            <Status>accomplished</Status>
            <SnapshotId>s-23f2i9s4t</SnapshotId>
            <Usage>none</Usage>
        </Snapshot>
        <Snapshot>
            <CreationTime>2014-07-24T13:00:42Z</CreationTime>
            <Description></Description>
            <SourceDiskId>101-70105379</SourceDiskId>
            <SourceDiskType>DATA</SourceDiskType>
            <ProductCode></ProductCode>
            <SnapshotName>auto_20140724_2</SnapshotName>
            <Progress>100%</Progress>
            <SourceDiskSize>5</SourceDiskSize>
            <Status>accomplished</Status>
            <SnapshotId>s-23izto5qm</SnapshotId>
            <Usage>none</Usage>
        </Snapshot>
    </Snapshots>
    <PageNumber>1</PageNumber>
    <PageSize>2</PageSize>
    <TotalCount>36</TotalCount>
    <RequestId>2F409D67-329A-4405-B924-2FC28566B366</RequestId>
</DescribeSnapshotsResponse>
JSON 格式
{
  "PageNumber": 1,
  "PageSize": 2,
  "RequestId": "659F91C6-1949-43B0-90C4-B6342CA757D5",
  "Snapshots": {
    "Snapshot": [
      {
        "CreationTime": "2015-07-30T05:00:14Z",
        "Progress": "100%",
        "SnapshotId": "s-943ypfgic",
        "SnapshotName": "auto_20150730_3",
        "SourceDiskId": "d-944qyqjfa",
        "SourceDiskSize": 20,
        "SourceDiskType": "system",
        "Status": "accomplished",
        "Usage": "none"
      },
      {
        "CreationTime": "2015-07-30T05:00:14Z",
        "Progress": "100%",
        "SnapshotId": "s-94osg320e",
        "SnapshotName": "auto_20150730_3",
        "SourceDiskId": "d-94j355jsq",
        "SourceDiskSize": 20,
        "SourceDiskType": "system",
        "Status": "accomplished",
        "Usage": "none"
      }
    ]
  },
  "TotalCount": 36
}

错误码

以下为本接口特有的错误码。更多错误码,请访问 API 错误中心

错误代码 错误信息 HTTP 状态码 说明
InvalidTag.Mismatch The specified Tag.n.Key and Tag.n.Value are not match. 400 指定的参数 Tag.n.KeyTag.n.Value 不匹配。
InvalidTagCount The specified tags are beyond the permitted range. 400 指定的标签数超过了 5 个。
InvalidSnapshotIds.Malformed The amount of specified specified snapshot Ids exceeds the limit. 403 指定的参数 SnapshotIds 格式不正确。
InvalidSnapshotType.NotFound The specfied SnapshotType is not found. 404 指定的参数 SnapshotType 取值有误。
InvalidSourceDiskType The specifed SourceDiskType is not valid. 404 指定的参数 SourceDiskType 不合法。
InvalidStatus.NotFound The specified Status is not found. 404 指定的参数 Status 取值有误。
InvalidUsage The specifed Usage is not valid. 404 指定的参数 Usage 不合法。