查詢雲端硬碟快照鏈。快照鏈是一塊雲端硬碟所有快照組成的關係鏈,一塊雲端硬碟對應一條快照鏈。
介面說明
介面說明
呼叫該介面時,您需要注意:
-
請求參數
RegionId、DiskIds和InstanceId等充當過濾器功能,參數間是邏輯與關係。 -
如果不指定任何參數,則過濾器不起作用。當
DiskIds和SnapshotLinkIds都為空陣列時,同樣視該過濾器有效,但是返回結果為空。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
ecs:DescribeSnapshotLinks |
get |
*All Resource
|
無 | 無 |
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| 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. | |
| 400 | InvalidSnapshotLinkIds | The specified snapshotLinkIds is invalid. | |
| 400 | InvalidDiskIds | The specified diskIds is invalid. | |
| 500 | InternalError | The request processing has failed due to some unknown error. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。