调用DescribeSnapshotLinks查询云盘快照链。快照链是一块云盘所有快照组成的关系链,一块云盘对应一条快照链。

接口说明

调用该接口时,您需要注意:

  • 请求参数RegionIdDiskIdsInstanceId等充当过滤器功能,参数间是逻辑与关系。
  • 如果不指定任何参数,则过滤器不起作用。当DiskIdsSnapshotLinkIds都为空数组时,同样视该过滤器有效,但是返回结果为空。

调试

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

请求参数

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

系统规定参数。取值:DescribeSnapshotLinks

RegionId String cn-hangzhou

云盘所属于的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。

InstanceId String i-bp1h6jmbefj2cyqs****

实例ID。

DiskIds String ["d-bp1d6tsvznfghy7y****", "d-bp1ippxbaql9zet7****", … "d-bp1ib7bcz07lcxa9****"]

云盘ID。一次最多指定100个云盘ID。DiskIds参数取值格式为JSON数组,ID之间用半角逗号(,)隔开。

SnapshotLinkIds String ["sl-bp1grgphbcc9brb5****", "sl-bp1c4izumvq0i5bs****", … "sl-bp1akk7isz866dds****"]

快照链ID。一次最多指定100个快照ID。SnapshotLinkIds参数取值格式为JSON数组,ID之间用半角逗号(,)隔开。

PageNumber Integer 1

云盘状态列表的页码。起始值:1

默认值:1

PageSize Integer 50

分页查询时设置的每页行数。取值范围:1~100

默认值:10

返回数据

名称 类型 示例值 描述
PageNumber Integer 1

快照链列表的页码。

PageSize Integer 50

输入时设置的每页行数。

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

请求ID。

SnapshotLinks Array

快照链信息组成的集合。

SnapshotLink
Category String test
InstanceId String i-bp1h6jmbefj2cyqs****

实例ID。

InstanceName String testInstanceName

实例名称。

RegionId String cn-hangzhou

快照链源云盘所属地域ID。

SnapshotLinkId String sl-2ze0y1jwzpb1geqx****

快照链ID。

SourceDiskId String d-bp1d6tsvznfghy7y****

源云盘ID,如果快照的源云盘已经被删除,该字段仍旧保留。

SourceDiskName String testSourceDiskName

源云盘的名称。

SourceDiskSize Integer 40

源云盘容量,单位为GiB。

SourceDiskType String cloud_ssd

源云盘的类型。可能值:

  • cloud_efficiency:高效云盘
  • cloud_ssd:SSD云盘
  • cloud_essd:ESSD云盘
  • ephemeral_ssd:本地SSD盘
  • cloud:普通云盘
TotalCount Integer 1

快照总个数。

TotalSize Long 2097152

快照链中所有快照的大小,单位为Byte。

TotalCount Integer 9

快照链总个数。

示例

请求示例

https://ecs.aliyuncs.com/?Action=DescribeSnapshotLinks
&RegionId=cn-hangzhou
&InstanceId=i-bp1h6jmbefj2cyqs****
&DiskIds=["d-bp1d6tsvznfghy7y****", "d-bp1ippxbaql9zet7****", … "d-bp1ib7bcz07lcxa9****"]
&SnapshotLinkIds=["sl-bp1grgphbcc9brb5****", "sl-bp1c4izumvq0i5bs****", … "sl-bp1akk7isz866dds****"]
&PageNumber=1
&PageSize=10
&<公共请求参数>

正常返回示例

XML 格式

<DescribeSnapshotLinksResponse>
      <SnapshotLinks>
            <SnapshotLink>
                  <SourceDiskSize>20</SourceDiskSize>
                  <TotalSize>2097152</TotalSize>
                  <SourceDiskType>data</SourceDiskType>
                  <RegionId>cn-beijing-btc-a01</RegionId>
                  <SnapshotLinkId>sl-2ze0y1jwzpb1geqx****</SnapshotLinkId>
                  <SourceDiskId>d-bp1d6tsvznfghy7y****</SourceDiskId>
                  <TotalCount>1</TotalCount>
            </SnapshotLink>
            <SnapshotLink>
                  <SourceDiskSize>40</SourceDiskSize>
                  <TotalSize>2097152</TotalSize>
                  <SourceDiskType>data</SourceDiskType>
                  <RegionId>cn-beijing-btc-a01</RegionId>
                  <SnapshotLinkId>sl-2ze0y1jwzpb1geqx****</SnapshotLinkId>
                  <SourceDiskId>d-bp1d6tsvznfghy7y****</SourceDiskId>
                  <TotalCount>1</TotalCount>
            </SnapshotLink>
      </SnapshotLinks>
      <PageNumber>1</PageNumber>
      <PageSize>2</PageSize>
      <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
      <TotalCount>9</TotalCount>
</DescribeSnapshotLinksResponse>

JSON 格式

{
    "SnapshotLinks": {
        "SnapshotLink": [
            {
                "SourceDiskSize": 20,
                "TotalSize": 2097152,
                "SourceDiskType": "data",
                "RegionId": "cn-beijing-btc-a01",
                "SnapshotLinkId": "sl-2ze0y1jwzpb1geqx****",
                "SourceDiskId": "d-bp1d6tsvznfghy7y****",
                "TotalCount": 1
            },
            {
                "SourceDiskSize": 40,
                "TotalSize": 2097152,
                "SourceDiskType": "data",
                "RegionId": "cn-beijing-btc-a01",
                "SnapshotLinkId": "sl-2ze0y1jwzpb1geqx****",
                "SourceDiskId": "d-bp1d6tsvznfghy7y****",
                "TotalCount": 1
            }
        ]
    },
    "PageNumber": 1,
    "PageSize": 2,
    "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
    "TotalCount": 9
}

错误码

HttpCode 错误码 错误信息 描述
400 InvalidRegionId The specified regionId is invalid. 指定的 RegionId 不合法。
400 InvalidSnapshotLinkIds The specified snapshotLinkIds is invalid. 指定的 SnapshotLinkId 不合法。
400 InvalidDiskIds The specified diskIds is invalid. 指定的磁盘无效。
500 InternalError The request processing has failed due to some unknown error. 内部错误,请重试。如果多次尝试失败,请提交工单。

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