查询云盘快照链。快照链是一块云盘所有快照组成的关系链,一块云盘对应一条快照链。
接口说明
接口说明
调用该接口时,您需要注意:
-
请求参数
RegionId、DiskIds和InstanceId等充当过滤器功能,参数间是逻辑与关系。 -
如果不指定任何参数,则过滤器不起作用。当
DiskIds和SnapshotLinkIds都为空数组时,同样视该过滤器有效,但是返回结果为空。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
ecs:DescribeSnapshotLinks |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| RegionId |
string |
是 |
云盘所属于的地域 ID。您可以调用 DescribeRegions 查看最新的阿里云地域列表。 |
cn-hangzhou |
| InstanceId |
string |
否 |
实例 ID。 |
i-bp1h6jmbefj2cyqs**** |
| DiskIds |
string |
否 |
云盘 ID。一次最多指定 100 个云盘 ID。DiskIds 参数取值格式为 JSON 数组,ID 之间用半角逗号(,)隔开。 |
["d-bp1d6tsvznfghy7y****", "d-bp1ippxbaql9zet7****", … "d-bp1ib7bcz07lcxa9****"] |
| SnapshotLinkIds |
string |
否 |
快照链 ID。一次最多指定 100 个快照 ID。SnapshotLinkIds 参数取值格式为 JSON 数组,ID 之间用半角逗号(,)隔开。 |
["sl-bp1grgphbcc9brb5****", "sl-bp1c4izumvq0i5bs****", … "sl-bp1akk7isz866dds****"] |
| PageNumber |
integer |
否 |
云盘状态列表的页码。起始值:1。 默认值:1 。 |
1 |
| PageSize |
integer |
否 |
分页查询时设置的每页行数。取值范围:1~100。 默认值:10。 |
50 |
| NextToken |
string |
否 |
查询凭证(Token),取值为上一次 API 调用返回的 NextToken 参数值。 |
caeba0bbb2be03f84eb48b699f0a**** |
| MaxResults |
integer |
否 |
分页查询时每页行数。最大值为 100。 默认值:
|
10 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| NextToken |
string |
本次调用返回的查询凭证值。 |
caeba0bbb2be03f84eb48b699f0a**** |
| PageSize |
integer |
输入时设置的每页行数。 |
50 |
| RequestId |
string |
请求 ID。 |
473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E |
| PageNumber |
integer |
快照链列表的页码。 |
1 |
| TotalCount |
integer |
快照链总个数。 说明
使用 |
9 |
| SnapshotLinks |
object |
||
| SnapshotLink |
array<object> |
快照链信息组成的集合。 |
|
|
object |
|||
| InstantAccess |
boolean |
是否开启了快照极速可用功能。可能值:
说明
该参数已弃用。ESSD 云盘标准快照已升级为默认极速可用,您无需额外配置,且不产生额外花销。 |
false |
| TotalSize |
integer |
快照链中所有快照的大小,单位:Byte。 |
2097152 |
| SourceDiskName |
string |
源云盘的名称。 |
testSourceDiskName |
| SourceDiskSize |
integer |
源云盘容量,单位:GiB。 |
40 |
| SourceDiskType |
string |
源云盘的云盘类型。可能值:
|
data |
| InstanceId |
string |
实例 ID。 |
i-bp1h6jmbefj2cyqs**** |
| SnapshotLinkId |
string |
快照链 ID。 |
sl-2ze0y1jwzpb1geqx**** |
| TotalCount |
integer |
快照总个数。 |
1 |
| RegionId |
string |
快照链源云盘所属地域 ID。 |
cn-hangzhou |
| SourceDiskId |
string |
源云盘 ID,如果快照的源云盘已经被删除,该字段仍旧保留。 |
d-bp1d6tsvznfghy7y**** |
| InstanceName |
string |
实例名称。 |
testInstanceName |
| Category |
string |
快照链类型。可能值:
|
standard |
示例
正常返回示例
JSON格式
{
"NextToken": "caeba0bbb2be03f84eb48b699f0a****",
"PageSize": 50,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"PageNumber": 1,
"TotalCount": 9,
"SnapshotLinks": {
"SnapshotLink": [
{
"InstantAccess": false,
"TotalSize": 2097152,
"SourceDiskName": "testSourceDiskName",
"SourceDiskSize": 40,
"SourceDiskType": "data",
"InstanceId": "i-bp1h6jmbefj2cyqs****",
"SnapshotLinkId": "sl-2ze0y1jwzpb1geqx****",
"TotalCount": 1,
"RegionId": "cn-hangzhou",
"SourceDiskId": "d-bp1d6tsvznfghy7y****",
"InstanceName": "testInstanceName",
"Category": "standard"
}
]
}
}
异常返回示例
JSON格式
{
"SnapshotLinks": {
"SnapshotLink": [
{
"SourceDiskSize": 20,
"TotalSize": 2097152,
"SourceDiskType": "data",
"RegionId": "cn-beijing-btc-a01",
"SnapshotLinkId": "d-25okbh2pj",
"SourceDiskId": "d-25okbh2pj",
"TotalCount": 1
},
{
"SourceDiskSize": 40,
"TotalSize": 2097152,
"SourceDiskType": "data",
"RegionId": "cn-beijing-btc-a01",
"SnapshotLinkId": "d-2ze0y1jwzpb1geqxkroq",
"SourceDiskId": "d-2ze0y1jwzpb1geqxkroq",
"TotalCount": 1
}
]
},
"PageNumber": 1,
"PageSize": 2,
"RequestId": "ACD9BBB0-A9D1-46D7-9630-B7A69889E110",
"TotalCount": 9
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidInstanceId.NotFound | The specified instanceId is not exists. | |
| 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. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。