阅读322 返回首页    go 阿里云

查询快照__快照相关接口_API 参考_云服务器 ECS-阿里云

描述

查询针对云服务器的某个磁盘设备所有的快照列表。

InstanceId，DiskId 和 SnapshotIds 不再作为必选参数，而是作为 Filter 进行使用，为逻辑与关系。

请求参数

名称 类型 是否必须 描述
Action String 是 系统规定参数，取值：DescribeSnapshots
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
SnapshotType String 否 快照类型，auto | user | all
SourceDiskType String 否 快照源磁盘的磁盘类型，System | Data
Usage String 否 有引用关系的资源类型，image | disk | image_disk | none
Tag.n.Key String 否 标签 key，n 从 1 开始，最大为 5。
不允许为空字符串。
Tag.n.Value String 否 标签 value，n 从 1 开始，最大为 5。
允许为空字符串。
PageNumber Integer 否 磁盘状态列表的页码，起始值为 1，默认值为 1
PageSize Integer 否 分页查询时设置的每页行数，最大值 100 行，默认为 10

返回参数

名称 类型 描述
RegionId String 镜像所属地域 Id
TotalCount Integer 快照总个数
PageNumber Integer 快照列表的页码
PageSize Integer 输入时设置的每页行数
Snapshots SnapshotType 快照详情 SnapshotType 组成的集合

错误码

错误代码 描述 Http 状态码 语义
MissingParameter The input parameter "RegionId" that is mandatory for processing this request is not supplied. 400 RegionId 参数未指定
InvalidParameter The specified parameter "PageNumber" is not valid. 400 指定的 PageNumber 参数不合法
InvalidParameter The specified parameter "PageSize" is not valid. 400 指定的 PageSize 参数不合法
InvalidSnapshotIds.Malformed The amount of specified specified snapshot Ids exceeds the limit. 403 SnapshotIds 参数格式不正确
InvalidUsage The specified Usage is not valid 404 指定的 Usage 不合法
InvalidSourceDiskType The specified SourceDiskType is not valid 404 指定的 SourceDiskType 不合法
InvalidStatus.NotFound The specified Status is not found 404 指定的 Status 不存在
InvalidSnapshotType.NotFound The specfied SnapshotType is not found 404 指定的 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
}

最后更新：2016-11-23 17:16:02

  上一篇：go 扩容磁盘__磁盘相关接口_API 参考_云服务器 ECS-阿里云
  下一篇：go 释放自动快照策略__快照相关接口_API 参考_云服务器 ECS-阿里云