功能介紹
查詢 云硬盤 快照詳情列表。
調(diào)試
您可以在API Explorer中調(diào)試該接口，支持自動(dòng)認(rèn)證鑒權(quán)。API Explorer可以自動(dòng)生成SDK代碼示例，并提供SDK代碼示例調(diào)試功能。
URI
GET /v2/{project_id}/cloudsnapshots/detail
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
項(xiàng)目ID。 獲取方法請(qǐng)參見"獲取項(xiàng)目ID"。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
offset |
否 |
Integer |
偏移量。 說明:分頁查詢快照時(shí)使用，與limit配合使用。假如共有30個(gè)快照，設(shè)置offset為11，limit為10，即為從第12個(gè)快照開始查詢，一次最多可讀取10個(gè)快照。 |
|
limit |
否 |
Integer |
返回結(jié)果個(gè)數(shù)限制，值為大于0的整數(shù)。默認(rèn)值為1000。 |
|
name |
否 |
String |
云硬盤快照名稱。最大支持255個(gè)字節(jié)。 |
|
status |
否 |
String |
云硬盤快照狀態(tài)，具體請(qǐng)參見云硬盤快照狀態(tài)。 |
|
volume_id |
否 |
String |
快照所屬云硬盤的ID。 |
|
availability_zone |
否 |
String |
快照所屬云硬盤的可用區(qū)。 |
|
id |
否 |
String |
指定快照id進(jìn)行過濾?？梢詡魅攵鄠€(gè)id過濾查詢，格式：id=id1&id=id2&id=id3 |
|
dedicated_storage_name |
否 |
String |
專屬存儲(chǔ)的名稱。 |
|
dedicated_storage_id |
否 |
String |
專屬存儲(chǔ)ID。 |
|
service_type |
否 |
String |
服務(wù)類型。僅支持EVS、DSS、DESS。 |
|
enterprise_project_id |
否 |
String |
指定企業(yè)項(xiàng)目id進(jìn)行過濾。 傳入“all_granted_eps”，代表查詢權(quán)限范圍內(nèi)的所有企業(yè)項(xiàng)目下的云硬盤。 說明：
關(guān)于企業(yè)項(xiàng)目ID的獲取及企業(yè)項(xiàng)目特性的詳細(xì)信息，請(qǐng)參考："企業(yè)管理用戶指南"。 |
請(qǐng)求參數(shù)
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用戶Token。 通過調(diào)用 IAM 服務(wù)獲取用戶Token接口獲?。憫?yīng)消息頭中X-Subject-Token的值）。 |
響應(yīng)參數(shù)
狀態(tài)碼： 200
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
count |
Integer |
快照的總數(shù)量，不受limi參數(shù)的影響。 |
|
snapshots |
快照信息。 |
|
|
snapshots_links |
云硬盤快照列表查詢位置標(biāo)記。當(dāng)查詢時(shí)指定limit時(shí)會(huì)返回該字段，返回該字段表示本次查詢只查出了部分云硬盤快照信息。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
云硬盤快照ID。 |
|
status |
String |
云硬盤快照的狀態(tài)。 |
|
name |
String |
云硬盤快照名稱。 |
|
description |
String |
云硬盤快照描述信息。 |
|
created_at |
String |
云硬盤快照創(chuàng)建時(shí)間。 |
|
updated_at |
String |
云硬盤快照更新時(shí)間。 |
|
metadata |
Map<String,String> |
云硬盤快照的元數(shù)據(jù)信息。 |
|
volume_id |
String |
快照所屬的云硬盤。 |
|
size |
Integer |
云硬盤快照大小。 |
|
os-extended-snapshot-attributes:project_id |
String |
項(xiàng)目ID。 |
|
os-extended-snapshot-attributes:progress |
String |
快照進(jìn)度。 |
|
dedicated_storage_id |
String |
專屬存儲(chǔ)ID。 |
|
dedicated_storage_name |
String |
專屬存儲(chǔ)名稱。 |
|
service_type |
String |
服務(wù)類型。 |
狀態(tài)碼： 400
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
error |
出現(xiàn)錯(cuò)誤時(shí)，返回的錯(cuò)誤信息，具體請(qǐng)參見 error參數(shù)說明。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
code |
String |
出現(xiàn)錯(cuò)誤時(shí)，返回的錯(cuò)誤碼。錯(cuò)誤碼和其對(duì)應(yīng)的含義請(qǐng)參考錯(cuò)誤碼說明。 |
|
message |
String |
出現(xiàn)錯(cuò)誤時(shí)，返回的錯(cuò)誤消息。 |
請(qǐng)求示例
GET https://{endpoint}/v2/{project_id}/cloudsnapshots/detail
https://{endpoint}/v2/{project_id}/cloudsnapshots/detail
響應(yīng)示例
狀態(tài)碼： 200
OK
{
"count" : 3,
"snapshots_links" : [ {
"href" : "https://{endpoint}/v2/20a68d6b7a124ae2b6b8a22046ee5966/
cloudsnapshots/detail?limit=1&marker=fc05d5d7-7e99-42fb-b6f2-9ddd1b990e67",
"rel" : "next"
} ],
"snapshots" : [ {
"status" : "available",
"updated_at" : "2018-06-06T10:58:47.349051",
"volume_id" : "f687bd70-37b3-4f00-a900-0ba1cfaa5196",
"id" : "fc05d5d7-7e99-42fb-b6f2-9ddd1b990e67",
"size" : 1,
"os-extended-snapshot-attributes:progress" : "100%",
"name" : "test03",
"os-extended-snapshot-attributes:project_id" : "20a68d6b7a124ae2b6b8a22046ee5966",
"service_type" : "EVS",
"created_at" : "2018-05-30T03:14:44.457975",
"metadata" : { }
} ]
}
狀態(tài)碼： 400
Bad Request
{
"error" : {
"message" : "XXXX",
"code" : "XXX"
}
}
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
錯(cuò)誤碼
請(qǐng)參見錯(cuò)誤碼。
