功能介紹
查詢單個 云硬盤 的詳細(xì)信息。支持企業(yè)項(xiàng)目授權(quán)功能。
調(diào)試
您可以在API Explorer中調(diào)試該接口,支持自動認(rèn)證鑒權(quán)。API Explorer可以自動生成SDK代碼示例,并提供SDK代碼示例調(diào)試功能。
URI
GET /v2/{project_id}/cloudvolumes/{volume_id}
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
項(xiàng)目ID。獲取方法請參見"獲取項(xiàng)目ID"。 |
volume_id |
是 |
String |
云硬盤ID。 |
請求參數(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ù)類型 |
描述 |
---|---|---|
id |
String |
云硬盤的ID。 |
links |
云硬盤URI自描述信息。 |
|
name |
String |
云硬盤名稱。 |
status |
String |
云硬盤狀態(tài),請參見云硬盤狀態(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)建時間。 時間格式: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ì)說明,具體請參見:"查詢鏡像詳情"。 |
volume_type |
String |
云硬盤類型。 目前支持"SATA","SAS","GPSSD","SSD","ESSD","GPSSD2","ESSD2"七種。
|
size |
Integer |
云硬盤大小,單位為GiB。 |
consistencygroup_id |
String |
預(yù)留屬性。 |
bootable |
String |
是否為啟動云硬盤。 true:表示為啟動云硬盤。 false:表示為非啟動云硬盤。 |
metadata |
Map<String,Object> |
云硬盤的元數(shù)據(jù)。 __system__cmkid metadata中的加密cmkid字段,與__system__encrypted配合表示需要加密,cmkid長度固定為36個字節(jié)。> > 請求獲取密鑰ID的方法請參考:"查詢密鑰列表"。__system__encryptedmetadata中的表示加密功能的字段,0代表不加密,1代表加密。不指定該字段時,云硬盤的加密屬性與數(shù)據(jù)源保持一致,如果不是從數(shù)據(jù)源創(chuàng)建的場景,則默認(rèn)不加密。full_clone從快照創(chuàng)建云硬盤時的創(chuàng)建方式。* 0表示使用鏈接克隆方式。* 1表示使用全量克隆方式。hw:passthrough* true表示云硬盤的設(shè)備類型為SCSI類型,即允許ECS操作系統(tǒng)直接訪問底層存儲介質(zhì)。支持SCSI鎖命令。* false表示云硬盤的設(shè)備類型為VBD (虛擬塊存儲設(shè)備 , Virtual Block Device)類型,即為默認(rèn)類型,VBD只能支持簡單的SCSI讀寫命令。* 該字段不存在時,云硬盤默認(rèn)為VBD類型。orderIDmetadata中的表示云硬盤計(jì)費(fèi)類型的字段。當(dāng)該字段有值時,表示該云硬盤的計(jì)費(fèi)類型為包周期計(jì)費(fèi),否則計(jì)費(fèi)類型為按需計(jì)費(fèi)。 |
updated_at |
String |
云硬盤更新時間。 時間格式: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)廢棄,請使用multiattach。 |
user_id |
String |
預(yù)留屬性。 |
service_type |
String |
服務(wù)類型,結(jié)果為EVS、DSS、DESS。 |
multiattach |
Boolean |
是否為共享云硬盤。 |
dedicated_storage_id |
String |
云硬盤所屬的專屬存儲池ID。 |
dedicated_storage_name |
String |
云硬盤所屬的專屬存儲池的名稱。 |
tags |
Map<String,String> |
云硬盤的標(biāo)簽。 如果云硬盤有標(biāo)簽,則會有該字段,否則該字段為空。 |
wwn |
String |
云硬盤掛載時的唯一標(biāo)識。 |
enterprise_project_id |
String |
云硬盤上綁定的企業(yè)項(xiàng)目ID。> > 關(guān)于企業(yè)項(xiàng)目ID的獲取及企業(yè)項(xiàng)目特性的詳細(xì)信息,請參見:"企業(yè)管理用戶指南"。 |
serial_number |
String |
云硬盤序列號。 只有SCSI類型的非雙活云硬盤才會返回該字段,用于與虛擬機(jī)中的盤做對應(yīng)關(guān)系。 |
iops |
云硬盤的iops信息,云硬盤類型是ESSD2、GPSSD2才存在。 |
|
throughput |
云硬盤的吞吐量信息,云硬盤類型是GPSSD2才存在。 |
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
attached_at |
String |
掛載的時間信息。 時間格式:UTC YYYY-MM-DDTHH:MM:SS.XXXXXX |
attachment_id |
String |
掛載信息對應(yīng)的ID。 |
device |
String |
掛載點(diǎn)。 |
host_name |
String |
云硬盤掛載到的 云服務(wù)器 對應(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)識。 |
total_val |
Integer |
iops大小。 |
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
frozened |
Boolean |
凍結(jié)標(biāo)簽。 缺省值:false |
id |
String |
云硬盤吞吐量標(biāo)識。 |
total_val |
Integer |
吞吐量大小。 |
狀態(tài)碼: 400
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
error |
出現(xiàn)錯誤時,返回的錯誤信息,具體請參見 error參數(shù)說明。 |
參數(shù) |
參數(shù)類型 |
描述 |
---|---|---|
code |
String |
出現(xiàn)錯誤時,返回的錯誤碼。錯誤碼和其對應(yīng)的含義請參考錯誤碼說明。 |
message |
String |
出現(xiàn)錯誤時,返回的錯誤消息。 |
請求示例
GET https://{endpoint}/v2/{project_id}/cloudvolumes/{volume_id}
響應(yīng)示例
狀態(tài)碼: 200
云硬盤的信息。
{ "volume" : { "attachments" : [ ], "links" : [ { "href" : "https://volume.az0.dc1.domainname.com/v2/40acc331ac784f34842ba4f08ff2be48/
volumes/591ac654-26d8-41be-bb77-4f90699d2d41", "rel" : "self" }, { "href" : "https://volume.az0.dc1.domainname.com/40acc331ac784f34842ba4f08ff2be48/
volumes/591ac654-26d8-41be-bb77-4f90699d2d41", "rel" : "bookmark" } ], "availability_zone" : "az-dc-1", "os-vol-host-attr:host" : "az-dc-1#SSD", "multiattach" : true, "updated_at" : "2016-02-03T02:19:29.895237", "replication_status" : "disabled", "id" : "591ac654-26d8-41be-bb77-4f90699d2d41", "size" : 40, "user_id" : "fd03ee73295e45478d88e15263d2ee4e", "os-vol-tenant-attr:tenant_id" : "40acc331ac784f34842ba4f08ff2be48", "metadata" : { }, "tags" : { "key1" : "value1", "key2" : "value2" }, "status" : "available", "description" : "auto-created_from_restore_from_backup", "name" : "restore_backup_0115efb3-678c-4a9e-bff6-d3cd278238b9", "bootable" : "false", "created_at" : "2016-02-03T02:19:11.723797", "service_type" : "EVS", "wwn" : " 688860300000d136fa16f48f05992360" } }
狀態(tài)碼: 400
Bad Request
{
"error" : {
"message" : "XXXX",
"code" : "XXX"
}
}
狀態(tài)碼
狀態(tài)碼 |
描述 |
---|---|
200 |
云硬盤的信息。 |
400 |
Bad Request |
錯誤碼
請參見錯誤碼。