功能介紹
查詢所有 云硬盤 的詳細(xì)信息。
調(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}/cloudvolumes/detail
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
項(xiàng)目ID。獲取方法請(qǐng)參見(jiàn)"獲取項(xiàng)目ID"。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
marker |
否 |
String |
通過(guò)云硬盤ID進(jìn)行分頁(yè)查詢，默認(rèn)為查詢第一頁(yè)數(shù)據(jù)。marker={{id}}表示查詢?cè)撛朴脖Pid后的所有云硬盤的信息(查詢結(jié)果不包含該id的云硬盤信息)。 |
|
name |
否 |
String |
磁盤名稱。 |
|
limit |
否 |
Integer |
返回結(jié)果個(gè)數(shù)限制。默認(rèn)值為1000。 最小值：1 最大值：1000 缺省值：1000 |
|
sort_key |
否 |
String |
返回結(jié)果按該關(guān)鍵字排序，支持id，status，size，created_at等關(guān)鍵字，默認(rèn)為“created_at”。 |
|
offset |
否 |
Integer |
偏移量（偏移量為一個(gè)大于0小于磁盤總個(gè)數(shù)的整數(shù)，表示查詢?cè)撈屏亢竺娴乃械拇疟P）。 |
|
sort_dir |
否 |
String |
返回結(jié)果按照降序或升序排列，默認(rèn)為“desc”。 降序：desc 升序：asc |
|
status |
否 |
String |
云硬盤狀態(tài)，取值可參考："云硬盤狀態(tài)"。 |
|
metadata |
否 |
String |
云硬盤元數(shù)據(jù)。 |
|
availability_zone |
否 |
String |
可用區(qū)信息。 |
|
multiattach |
否 |
Boolean |
是否為共享云硬盤。 true：表示為共享云硬盤。 false：表示為非共享云硬盤。 |
|
service_type |
否 |
String |
服務(wù)類型，僅支持EVS、DSS、DESS。 |
|
dedicated_storage_id |
否 |
String |
專屬存儲(chǔ)池ID，可過(guò)濾出該專屬存儲(chǔ)池下的所有云硬盤，必須精確匹配。 |
|
dedicated_storage_name |
否 |
String |
專屬存儲(chǔ)池的名字，可過(guò)濾出該專屬存儲(chǔ)池下的所有云硬盤，支持模糊匹配。 |
|
volume_type_id |
否 |
String |
云硬盤類型id。通過(guò)"查詢?cè)朴脖P類型列表"可以查到，即volume_types參數(shù)說(shuō)明表格中的“id” |
|
id |
否 |
String |
云硬盤ID。 |
|
ids |
否 |
String |
云硬盤id列表，格式為ids=['id1','id2',...,'idx']，返回“ids”中有效id的云硬盤詳情，無(wú)效的id會(huì)被忽略。 支持查詢最多60個(gè)id對(duì)應(yīng)的云硬盤詳情。 如果“id”和“ids”查詢參數(shù)同時(shí)存在，“id”會(huì)被忽略。 |
|
enterprise_project_id |
否 |
String |
指定企業(yè)項(xiàng)目id進(jìn)行過(guò)濾。傳入“all_granted_eps”，代表查詢權(quán)限范圍內(nèi)的所有企業(yè)項(xiàng)目下的云硬盤。> > 關(guān)于企業(yè)項(xiàng)目ID的獲取及企業(yè)項(xiàng)目特性的詳細(xì)信息，請(qǐng)參考："企業(yè)管理用戶指南"。 |
|
server_id |
否 |
String |
云服務(wù)器 id。 |
|
bootable |
否 |
Boolean |
是否為啟動(dòng)盤/系統(tǒng)盤，true表示為啟動(dòng)盤/系統(tǒng)盤，false表示為數(shù)據(jù)盤 |
請(qǐng)求參數(shù)
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用戶Token。 通過(guò)調(diào)用 IAM 服務(wù)獲取用戶Token接口獲?。憫?yīng)消息頭中X-Subject-Token的值）。 |
響應(yīng)參數(shù)
狀態(tài)碼： 200
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
count |
Integer |
查詢到的云硬盤總數(shù)量，不受分頁(yè)影響。 |
|
volumes_links |
云硬盤列表查詢位置標(biāo)記。如果本次查詢只返回部分列表信息時(shí)，會(huì)返回查詢到的當(dāng)前云硬盤mark標(biāo)記的url，可以繼續(xù)使用這個(gè)url查詢剩余列表信息。 |
|
|
volumes |
查詢請(qǐng)求返回的云硬盤列表。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
id |
String |
云硬盤的ID。 |
|
links |
云硬盤URI自描述信息。 |
|
|
name |
String |
云硬盤名稱。 |
|
status |
String |
云硬盤狀態(tài)，請(qǐng)參見(jiàn)云硬盤狀態(tài)。 |
|
attachments |
云硬盤的掛載信息。 |
|
|
availability_zone |
String |
云硬盤所屬的AZ信息。 |
|
os-vol-host-attr:host |
String |
預(yù)留屬性。 |
|
source_volid |
String |
源云硬盤ID，如果是從源云硬盤創(chuàng)建，則有值。 當(dāng)前云硬盤服務(wù)不支持該字段。 |
|
snapshot_id |
String |
快照ID，如果是從快照創(chuàng)建，則有值。 |
|
description |
String |
云硬盤描述。 |
|
created_at |
String |
云硬盤創(chuàng)建時(shí)間。 時(shí)間格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX |
|
os-vol-tenant-attr:tenant_id |
String |
云硬盤所屬的租戶ID。租戶ID就是項(xiàng)目ID。 |
|
volume_image_metadata |
Map<String,Object> |
云硬盤 鏡像 的元數(shù)據(jù)。> > 關(guān)于“volume_image_metadata”字段的詳細(xì)說(shuō)明，具體請(qǐng)參見(jiàn)："查詢鏡像詳情"。 |
|
volume_type |
String |
云硬盤類型。 目前支持"SATA"，"SAS"，"GPSSD"，"SSD"，"ESSD"，"GPSSD2","ESSD2"七種。
|
|
size |
Integer |
云硬盤大小，單位為GiB。 |
|
consistencygroup_id |
String |
預(yù)留屬性。 |
|
bootable |
String |
是否為啟動(dòng)云硬盤。 true：表示為啟動(dòng)云硬盤。 false：表示為非啟動(dòng)云硬盤。 |
|
metadata |
Map<String,Object> |
云硬盤的元數(shù)據(jù)。 __system__cmkid metadata中的加密cmkid字段，與__system__encrypted配合表示需要加密，cmkid長(zhǎng)度固定為36個(gè)字節(jié)。> > 請(qǐng)求獲取密鑰ID的方法請(qǐng)參考："查詢密鑰列表"。__system__encryptedmetadata中的表示加密功能的字段，0代表不加密，1代表加密。不指定該字段時(shí)，云硬盤的加密屬性與數(shù)據(jù)源保持一致，如果不是從數(shù)據(jù)源創(chuàng)建的場(chǎng)景，則默認(rèn)不加密。full_clone從快照創(chuàng)建云硬盤時(shí)的創(chuàng)建方式。* 0表示使用鏈接克隆方式。* 1表示使用全量克隆方式。hw:passthrough* true表示云硬盤的設(shè)備類型為SCSI類型，即允許ECS操作系統(tǒng)直接訪問(wèn)底層存儲(chǔ)介質(zhì)。支持SCSI鎖命令。* false表示云硬盤的設(shè)備類型為VBD (虛擬塊存儲(chǔ)設(shè)備 , Virtual Block Device)類型，即為默認(rèn)類型，VBD只能支持簡(jiǎn)單的SCSI讀寫命令。* 該字段不存在時(shí)，云硬盤默認(rèn)為VBD類型。orderIDmetadata中的表示云硬盤計(jì)費(fèi)類型的字段。當(dāng)該字段有值時(shí)，表示該云硬盤的計(jì)費(fèi)類型為包周期計(jì)費(fèi)，否則計(jì)費(fèi)類型為按需計(jì)費(fèi)。 |
|
updated_at |
String |
云硬盤更新時(shí)間。 時(shí)間格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX |
|
encrypted |
Boolean |
當(dāng)前云硬盤服務(wù)不支持該字段。 |
|
replication_status |
String |
預(yù)留屬性。 |
|
os-volume-replication:extended_status |
String |
預(yù)留屬性。 |
|
os-vol-mig-status-attr:migstat |
String |
預(yù)留屬性。 |
|
os-vol-mig-status-attr:name_id |
String |
預(yù)留屬性。 |
|
shareable |
String |
是否為共享云硬盤。true為共享盤，false為普通云硬盤。 該字段已經(jīng)廢棄，請(qǐng)使用multiattach。 |
|
user_id |
String |
預(yù)留屬性。 |
|
service_type |
String |
服務(wù)類型，結(jié)果為EVS、DSS、DESS。 |
|
multiattach |
Boolean |
是否為共享云硬盤。 |
|
dedicated_storage_id |
String |
云硬盤所屬的專屬存儲(chǔ)池ID。 |
|
dedicated_storage_name |
String |
云硬盤所屬的專屬存儲(chǔ)池的名稱。 |
|
tags |
Map<String,String> |
云硬盤的標(biāo)簽。 如果云硬盤有標(biāo)簽，則會(huì)有該字段，否則該字段為空。 |
|
wwn |
String |
云硬盤掛載時(shí)的唯一標(biāo)識(shí)。 |
|
enterprise_project_id |
String |
云硬盤上綁定的企業(yè)項(xiàng)目ID。> > 關(guān)于企業(yè)項(xiàng)目ID的獲取及企業(yè)項(xiàng)目特性的詳細(xì)信息，請(qǐng)參見(jiàn)："企業(yè)管理用戶指南"。 |
|
serial_number |
String |
云硬盤序列號(hào)。 只有SCSI類型的非雙活云硬盤才會(huì)返回該字段，用于與虛擬機(jī)中的盤做對(duì)應(yīng)關(guān)系。 |
|
iops |
云硬盤的iops信息，云硬盤類型是ESSD2、GPSSD2才存在。 |
|
|
throughput |
云硬盤的吞吐量信息，云硬盤類型是GPSSD2才存在。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
attached_at |
String |
掛載的時(shí)間信息。 時(shí)間格式：UTC YYYY-MM-DDTHH:MM:SS.XXXXXX |
|
attachment_id |
String |
掛載信息對(duì)應(yīng)的ID。 |
|
device |
String |
掛載點(diǎn)。 |
|
host_name |
String |
云硬盤掛載到的云服務(wù)器對(duì)應(yīng)的物理主機(jī)的名稱。 |
|
id |
String |
掛載的資源ID。 |
|
server_id |
String |
云硬盤掛載到的云服務(wù)器的 ID。 |
|
volume_id |
String |
云硬盤ID。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
frozened |
Boolean |
凍結(jié)標(biāo)簽。 缺省值：false |
|
id |
String |
云硬盤iops標(biāo)識(shí)。 |
|
total_val |
Integer |
iops大小。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
frozened |
Boolean |
凍結(jié)標(biāo)簽。 缺省值：false |
|
id |
String |
云硬盤吞吐量標(biāo)識(shí)。 |
|
total_val |
Integer |
吞吐量大小。 |
狀態(tài)碼： 400
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
error |
出現(xiàn)錯(cuò)誤時(shí)，返回的錯(cuò)誤信息，具體請(qǐng)參見(jiàn) error參數(shù)說(shuō)明。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
code |
String |
出現(xiàn)錯(cuò)誤時(shí)，返回的錯(cuò)誤碼。錯(cuò)誤碼和其對(duì)應(yīng)的含義請(qǐng)參考錯(cuò)誤碼說(shuō)明。 |
|
message |
String |
出現(xiàn)錯(cuò)誤時(shí)，返回的錯(cuò)誤消息。 |
請(qǐng)求示例
GET https://{endpoint}/v2/{project_id}/cloudvolumes/detail
響應(yīng)示例
狀態(tài)碼： 200
OK
{ "count" : 1, "volumes" : [ { "attachments" : [ ], "availability_zone" : "az-dc-1", "bootable" : "false", "created_at" : "2016-05-25T02:42:10.856332", "id" : "b104b8db-170d-441b-897a-3c8ba9c5a214", "links" : [ { "href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/
volumes/b104b8db-170d-441b-897a-3c8ba9c5a214", "rel" : "self" }, { "href" : "https://volume.localdomain.com:8776/dd14c6ac581f40059e27f5320b60bf2f/volumes/b104b8db-170d-441b-897a-3c8ba9c5a214", "rel" : "bookmark" } ], "metadata" : { }, "name" : "zjb_u25_test", "os-vol-host-attr:host" : "pod01.xxx#SATA", "volume_image_metadata" : { }, "os-vol-tenant-attr:tenant_id" : "dd14c6ac581f40059e27f5320b60bf2f", "replication_status" : "disabled", "multiattach" : false, "size" : 1, "status" : "available", "updated_at" : "2016-05-25T02:42:22.341984", "user_id" : "b0524e8342084ef5b74f158f78fc3049", "volume_type" : "SATA", "service_type" : "EVS", "wwn" : " 688860300000d136fa16f48f05992360" } ], "volumes_links" : [ { "href" : "https://volume.localdomain.com:8776/v2/dd14c6ac581f40059e27f5320b60bf2f/volumes/
detail?limit=1&marker=b104b8db-170d-441b-897a-3c8ba9c5a214", "rel" : "next" } ] }
狀態(tài)碼： 400
Bad Request
{
"error" : {
"message" : "XXXX",
"code" : "XXX"
}
}
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
錯(cuò)誤碼
請(qǐng)參見(jiàn)錯(cuò)誤碼。
