调用ListSnapshots查询一个或多个已创建的快照信息。

接口说明

InstanceIdDiskIdSnapshotIds不是必需的请求参数,但是可以构建过滤器逻辑,参数之间为逻辑与(And)关系。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String ListSnapshots

系统规定参数。取值:ListSnapshots

RegionId String cn-hangzhou

快照对应的轻量应用服务器所属的地域ID。

InstanceId String 2ad1ae67295445f598017499dc****

指定的轻量应用服务器的实例ID。

DiskId String d-bp14wq0149cpp2xy****

指定的磁盘ID。

SnapshotIds String ["s-bp16oazlsold4dks****", "s-bp16oazlsold4abc****"]

快照ID。取值可以由多个快照ID组成一个JSON数组,最多支持100个ID,ID之间用半角逗号(,)隔开。

PageSize Integer 10

分页查询时设置的每页行数。最大值:100

默认值:10

PageNumber Integer 1

快照列表的页码。

默认值:1

返回数据

名称 类型 示例值 描述
Snapshots Array of Snapshot

快照信息组成的数组。

CreationTime String 2021-03-09T07:12:49Z

快照创建时间。时间格式以ISO8601为标准,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。

Progress String 100%

快照创建的进度。

RegionId String cn-hangzhou

地域ID。

Remark String test-Remark

快照备注。

SnapshotId String s-bp16oazlsold4dks****

快照ID。

SnapshotName String test-SnapshotName

快照名称。

SourceDiskId String d-bp14wq0149cpp2xy****

源磁盘ID。即使快照的源磁盘已经被释放,仍保留该返回值。

SourceDiskType String System

快照源磁盘的磁盘类型。可能值:

  • System:系统盘
  • Data:数据盘
Status String Accomplished

快照状态。可能值:

  • Progressing:正在创建
  • Accomplished:创建成功
  • Failed:创建失败
TotalCount Integer 1

快照的总条数。

PageSize Integer 10

分页查询时设置的每页行数。

PageNumber Integer 1

快照列表的页码。

RequestId String 20758A-585D-4A41-A9B2-28DA8F4F534F

请求ID。

示例

请求示例

https://swas.cn-hangzhou.aliyuncs.com/?Action=ListSnapshots
&DiskId=d-bp14wq0149cpp2xy****
&<公共请求参数>

正常返回示例

XML格式

<ListSnapshotsResponse>
      <TotalCount>1</TotalCount>
      <RequestId>20758A-585D-4A41-A9B2-28DA8F4F534F</RequestId>
      <PageSize>10</PageSize>
      <PageNumber>1</PageNumber>
      <Snapshots>
            <Status>Accomplished</Status>
            <SnapshotId>s-bp16oazlsold4dks****</SnapshotId>
            <Progress>100%</Progress>
            <CreationTime>2021-03-09T07:12:49Z</CreationTime>
            <RegionId>cn-hangzhou</RegionId>
            <SourceDiskType>System</SourceDiskType>
            <SnapshotName>test-SnapshotName</SnapshotName>
            <SourceDiskId>d-bp14wq0149cpp2xy****</SourceDiskId>
            <Remark>test-Remark</Remark>
      </Snapshots>
</ListSnapshotsResponse>

JSON格式

{
  "TotalCount": 1,
  "RequestId": "20758A-585D-4A41-A9B2-28DA8F4F534F",
  "PageSize": 10,
  "PageNumber": 1,
  "Snapshots": [
    {
      "Status": "Accomplished",
      "SnapshotId": "s-bp16oazlsold4dks****",
      "Progress": "100%",
      "CreationTime": "2021-03-09T07:12:49Z",
      "RegionId": "cn-hangzhou",
      "SourceDiskType": "System",
      "SnapshotName": "test-SnapshotName",
      "SourceDiskId": "d-bp14wq0149cpp2xy****",
      "Remark": "test-Remark"
    }
  ]
}

错误码

HttpCode 错误码 错误信息 描述
404 InvalidInstanceId.NotFound The specified InstanceId does not exist. 指定的实例不存在,请您检查实例ID是否正确。
404 InvalidDiskId.NotFound The specified DiskId does not exist. 指定的磁盘不存在,请您检查磁盘ID是否正确。
500 InternalError An error occurred while processing your request. 内部错误,请重试。如果多次尝试失败,请提交工单。
403 InvalidParam The specified parameter value is invalid. 参数非法。

访问错误中心查看更多错误码。