DescribeSnapshotLinks
调用DescribeSnapshotLinks查询云盘快照链。快照链是一块云盘所有快照组成的关系链,一块云盘对应一条快照链。
接口说明
调用该接口时,您需要注意:
- 请求参数
RegionId
、DiskIds
和InstanceId
等充当过滤器功能,参数间是逻辑与关系。 - 如果不指定任何参数,则过滤器不起作用。当
DiskIds
和SnapshotLinkIds
都为空数组时,同样视该过滤器有效,但是返回结果为空。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
RegionId | String | 是 | cn-hangzhou |
云盘所属于的地域ID。您可以调用DescribeRegions查看最新的阿里云地域列表。 |
Action | String | 否 | DescribeSnapshotLinks |
系统规定参数。取值:DescribeSnapshotLinks |
DiskIds | String | 否 | ["d-xxxxxxxxx", "d-yyyyyyyyy", … "d-zzzzzzzzz"] |
云盘ID。一次最多指定100个云盘ID。DiskIds参数取值格式为JSON数组,ID之间用半角逗号(,)隔开。 |
InstanceId | String | 否 | i-instanceid1 |
实例ID。 |
PageNumber | Integer | 否 | 1 |
云盘状态列表的页码。起始值:1 默认值:1 |
PageSize | Integer | 否 | 50 |
分页查询时设置的每页行数。取值范围:1~100。 默认值:10。 |
SnapshotLinkIds | String | 否 | ["sl-xxxxxxxxx", "sl-yyyyyyyyy", … "sl-zzzzzzzzz"] |
快照链ID。一次最多指定100个快照ID。SnapshotLinkIds参数取值格式为JSON数组,ID之间用半角逗号(,)隔开。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
PageNumber | Integer | 1 |
快照链列表的页码。 |
PageSize | Integer | 50 |
输入时设置的每页行数。 |
RequestId | String | 473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
请求ID。 |
SnapshotLinks |
快照链信息组成的集合。 |
||
SnapshotLink |
快照链信息组成的集合。 |
||
InstanceId | String | i-instanceid1 |
实例ID。 |
InstanceName | String | FinanceJoshua |
实例名称。 |
RegionId | String | cn-hangzhou |
快照链源云盘所属地域ID。 |
SnapshotLinkId | String | sl-2ze0y1jwzpb1geqxk*** |
快照链ID。 |
SourceDiskId | String | d-diskid1 |
源云盘ID,如果快照的源云盘已经被删除,该字段仍旧保留。 |
SourceDiskName | String | FinanceJoshua |
源云盘的名称。 |
SourceDiskSize | Integer | 40 |
源云盘容量,单位为GiB。 |
SourceDiskType | String | cloud_ssd |
源云盘的类型。可能值:
|
TotalCount | Integer | 1 |
快照总个数。 |
TotalSize | Long | 2097152 |
快照链中所有快照的大小,单位为Byte。 |
TotalCount | Integer | 9 |
快照链总个数。 |
示例
请求示例
https://ecs.aliyuncs.com/?Action=DescribeSnapshotLinks
&RegionId=cn-hangzhou
&InstanceId=i-instanceid1
&DiskIds=["d-xxxxxxxxx", "d-yyyyyyyyy", … "d-zzzzzzzzz"]
&SnapshotLinkIds=["sl-xxxxxxxxx", "sl-yyyyyyyyy", … "sl-zzzzzzzzz"]
&PageNumber=1
&PageSize=10
&<公共请求参数>
正常返回示例
XML
格式
<DescribeSnapshotLinksResponse>
<SnapshotLinks>
<SnapshotLink>
<SnapshotLinkId>sl-25okbh2**</SnapshotLinkId>
<SourceDiskId>d-25okbh2**</SourceDiskId>
<SourceDiskType>data</SourceDiskType>
<SourceDiskSize>20</SourceDiskSize>
<RegionId> cn-beijing-btc-a01</RegionId>
<TotalCount>1</TotalCount>
<TotalSize>2097152</TotalSize>
</SnapshotLink>
<SnapshotLink>
<SnapshotLinkId>sl-2ze0y1j**</SnapshotLinkId>
<SourceDiskId>d-2ze0y1j**</SourceDiskId>
<SourceDiskType>system</SourceDiskType>
<SourceDiskSize>40</SourceDiskSize>
<RegionId> cn-beijing-btc-a01</RegionId>
<TotalCount>1</TotalCount>
<TotalSize>2097152</TotalSize>
</SnapshotLink>
</SnapshotLinks>
<PageNumber>1</PageNumber>
<PageSize>2</PageSize>
<TotalCount>9</TotalCount>
<RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E</RequestId>
</DescribeSnapshotLinksResponse>
JSON
格式
{
"PageNumber":1,
"TotalCount":9,
"PageSize":2,
"RequestId":"473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"SnapshotLinks":{
"SnapshotLink":[
{
"TotalCount":1,
"SourceDiskType":"data",
"SourceDiskId":"d-25okbh2**",
"RegionId":"cn-beijing-btc-a01",
"SourceDiskSize":20,
"SnapshotLinkId":"sl-25okbh2**",
"TotalSize":2097152
},
{
"TotalCount":1,
"SourceDiskType":"data",
"SourceDiskId":"d-2ze0y1**",
"RegionId":"cn-beijing-btc-a01",
"SourceDiskSize":40,
"SnapshotLinkId":"sl-2ze0y1j**",
"TotalSize":2097152
}
]
}
}
错误码
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. | 内部错误,请重试。如果多次尝试失败,请提交工单。 |
访问错误中心查看更多错误码。
版权声明
本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。
评论