功能介紹
通過(guò)標(biāo)簽查詢(xún) 云硬盤(pán) 資源實(shí)例詳情。
調(diào)試
您可以在API Explorer中調(diào)試該接口,支持自動(dòng)認(rèn)證鑒權(quán)。API Explorer可以自動(dòng)生成SDK代碼示例,并提供SDK代碼示例調(diào)試功能。
URI
POST /v2/{project_id}/cloudvolumes/resource_instances/action
參數(shù) |
是否必選 |
參數(shù)類(lèi)型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
項(xiàng)目ID。 獲取方法請(qǐng)參見(jiàn)"獲取項(xiàng)目ID"。 |
請(qǐng)求參數(shù)
參數(shù) |
是否必選 |
參數(shù)類(lèi)型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
用戶(hù)Token。 通過(guò)調(diào)用 IAM 服務(wù)獲取用戶(hù)Token接口獲取(響應(yīng)消息頭中X-Subject-Token的值)。 |
參數(shù) |
是否必選 |
參數(shù)類(lèi)型 |
描述 |
---|---|---|---|
action |
是 |
String |
操作標(biāo)識(shí)。 根據(jù)標(biāo)簽查詢(xún)?cè)朴脖P(pán)實(shí)例詳情時(shí)使用“filter”。 缺省值:filter 枚舉值:
|
limit |
否 |
Integer |
查詢(xún)記錄數(shù)。最小值1,最大值1000,默認(rèn)為1000。返回的結(jié)果中記錄數(shù)不超過(guò)limit值 最小值:1 最大值:1000 缺省值:1000 |
matches |
否 |
資源本身支持的查詢(xún)條件。標(biāo)簽列表中的標(biāo)簽key值不允許重復(fù)。 |
|
offset |
否 |
Integer |
索引位置。最小值0,默認(rèn)為0。返回的結(jié)果中第一條記錄為符合查詢(xún)條件的第“offset值+1”條記錄 缺省值:0 |
tags |
是 |
標(biāo)簽的鍵值對(duì)。標(biāo)簽列表中最多包含10個(gè)key 。標(biāo)簽列表中的標(biāo)簽key值不允許重復(fù)。標(biāo)簽列表中多個(gè)key之間是“與”的關(guān)系,云硬盤(pán)必須滿(mǎn)足請(qǐng)求中所有key才會(huì)匹配出來(lái)。 |
參數(shù) |
是否必選 |
參數(shù)類(lèi)型 |
描述 |
---|---|---|---|
key |
是 |
String |
鍵。取值范圍如下: resource_name:資源名稱(chēng)。 service_type:服務(wù)類(lèi)型。 枚舉值:
|
value |
是 |
String |
值。最大長(zhǎng)度255個(gè)字符。 key為“resource_name”時(shí),value為模糊匹配。 |
參數(shù) |
是否必選 |
參數(shù)類(lèi)型 |
描述 |
---|---|---|---|
key |
是 |
String |
標(biāo)簽鍵。 |
values |
是 |
Array of strings |
標(biāo)簽值。標(biāo)簽列表中最多包含10個(gè)value。標(biāo)簽列表中的標(biāo)簽value值不允許重復(fù)。標(biāo)簽列表如果為空列表,表示匹配任意值。標(biāo)簽列表中多個(gè)value之間是“或”的關(guān)系,在key已經(jīng)滿(mǎn)足要求的前提下,云硬盤(pán)滿(mǎn)足請(qǐng)求中的某個(gè)value就會(huì)匹配出來(lái)。 |
響應(yīng)參數(shù)
狀態(tài)碼: 200
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
---|---|---|
total_count |
Integer |
符合查詢(xún)條件的云硬盤(pán)資源個(gè)數(shù) |
resources |
符合查詢(xún)條件的資源列表 |
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
---|---|---|
resource_id |
String |
資源ID。 |
resource_name |
String |
資源名稱(chēng)。 |
resource_detail |
資源詳情。 |
|
tags |
Array of Map<String,String> objects |
標(biāo)簽列表。 |
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
---|---|---|
id |
String |
云硬盤(pán)的ID。 |
links |
云硬盤(pán)URI自描述信息。 |
|
name |
String |
云硬盤(pán)名稱(chēng)。 |
status |
String |
云硬盤(pán)狀態(tài),請(qǐng)參見(jiàn)云硬盤(pán)狀態(tài)。 |
attachments |
云硬盤(pán)的掛載信息。 |
|
availability_zone |
String |
云硬盤(pán)所屬的AZ信息。 |
os-vol-host-attr:host |
String |
預(yù)留屬性。 |
source_volid |
String |
源云硬盤(pán)ID,如果是從源云硬盤(pán)創(chuàng)建,則有值。 當(dāng)前云硬盤(pán)服務(wù)不支持該字段。 |
snapshot_id |
String |
快照ID,如果是從快照創(chuàng)建,則有值。 |
description |
String |
云硬盤(pán)描述。 |
created_at |
String |
云硬盤(pán)創(chuàng)建時(shí)間。 時(shí)間格式:UTC YYYY-MM-DDTHH:MM:SS.XXXXXX |
os-vol-tenant-attr:tenant_id |
String |
云硬盤(pán)所屬的租戶(hù)ID。租戶(hù)ID就是項(xiàng)目ID。 |
volume_image_metadata |
Map<String,Object> |
云硬盤(pán) 鏡像 的元數(shù)據(jù)。> 說(shuō)明:> > 關(guān)于“volume_image_metadata”字段的詳細(xì)說(shuō)明,具體請(qǐng)參見(jiàn):"查詢(xún)鏡像詳情"。 |
volume_type |
String |
云硬盤(pán)類(lèi)型。 目前支持“SSD”,“SAS”和“SATA”三種。 “SSD”為超高IO云硬盤(pán) “SAS”為高IO云硬盤(pán) “SATA”為普通IO云硬盤(pán) |
size |
Integer |
云硬盤(pán)大小,單位為GiB。 |
consistencygroup_id |
String |
預(yù)留屬性。 |
bootable |
String |
是否為啟動(dòng)云硬盤(pán)。 true:表示為啟動(dòng)云硬盤(pán)。 false:表示為非啟動(dòng)云硬盤(pán)。 |
metadata |
云硬盤(pán)的元數(shù)據(jù)。 |
|
updated_at |
String |
云硬盤(pán)更新時(shí)間。 時(shí)間格式:UTC YYYY-MM-DDTHH:MM:SS.XXXXXX |
encrypted |
Boolean |
當(dāng)前云硬盤(pán)服務(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 |
Boolean |
是否為共享云硬盤(pán)。true為共享盤(pán),false為普通云硬盤(pán)。 該字段已經(jīng)廢棄,請(qǐng)使用multiattach。 |
user_id |
String |
預(yù)留屬性。 |
service_type |
String |
服務(wù)類(lèi)型,結(jié)果為EVS、DSS、DESS。 |
multiattach |
Boolean |
是否為共享云硬盤(pán)。 |
dedicated_storage_id |
String |
云硬盤(pán)所屬的專(zhuān)屬存儲(chǔ)池ID。 |
dedicated_storage_name |
String |
云硬盤(pán)所屬的專(zhuān)屬存儲(chǔ)池的名稱(chēng)。 |
tags |
Map<String,String> |
云硬盤(pán)的標(biāo)簽。 如果云硬盤(pán)有標(biāo)簽,則會(huì)有該字段,否則該字段為空。 |
wwn |
String |
云硬盤(pán)掛載時(shí)的唯一標(biāo)識(shí)。 |
enterprise_project_id |
String |
云硬盤(pán)上綁定的企業(yè)項(xiàng)目ID。> 說(shuō)明:> > 關(guān)于企業(yè)項(xiàng)目ID的獲取及企業(yè)項(xiàng)目特性的詳細(xì)信息,請(qǐng)參見(jiàn):"企業(yè)管理用戶(hù)指南"。 |
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
---|---|---|
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 |
云硬盤(pán)掛載到的 云服務(wù)器 對(duì)應(yīng)的物理主機(jī)的名稱(chēng)。 |
id |
String |
掛載的資源ID。 |
server_id |
String |
云硬盤(pán)掛載到的云服務(wù)器的 ID。 |
volume_id |
String |
云硬盤(pán)ID。 |
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
---|---|---|
__system__cmkid |
String |
metadata中的加密cmkid字段,與__system__encrypted配合表示需要加密,cmkid長(zhǎng)度固定為36個(gè)字節(jié)。> > 請(qǐng)求獲取密鑰ID的方法請(qǐng)參考:"查詢(xún)密鑰列表"。 |
__system__encrypted |
String |
metadata中的表示加密功能的字段,0代表不加密,1代表加密。 不指定該字段時(shí),云硬盤(pán)的加密屬性與數(shù)據(jù)源保持一致,如果不是從數(shù)據(jù)源創(chuàng)建的場(chǎng)景,則默認(rèn)不加密。 |
full_clone |
String |
從快照創(chuàng)建云硬盤(pán)時(shí)的創(chuàng)建方式。
|
hw:passthrough |
String |
|
orderID |
String |
metadata中的表示云硬盤(pán)計(jì)費(fèi)類(lèi)型的字段。 當(dāng)該字段有值時(shí),表示該云硬盤(pán)的計(jì)費(fèi)類(lèi)型為包周期計(jì)費(fèi),否則計(jì)費(fèi)類(lèi)型為按需計(jì)費(fèi)。 |
狀態(tài)碼: 400
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
---|---|---|
error |
出現(xiàn)錯(cuò)誤時(shí),返回的錯(cuò)誤信息,具體請(qǐng)參見(jiàn) error參數(shù)說(shuō)明。 |
參數(shù) |
參數(shù)類(lèi)型 |
描述 |
---|---|---|
code |
String |
出現(xiàn)錯(cuò)誤時(shí),返回的錯(cuò)誤碼。錯(cuò)誤碼和其對(duì)應(yīng)的含義請(qǐng)參考錯(cuò)誤碼說(shuō)明。 |
message |
String |
出現(xiàn)錯(cuò)誤時(shí),返回的錯(cuò)誤消息。 |
請(qǐng)求示例
使用標(biāo)簽查詢(xún)名稱(chēng)為resource1的云硬盤(pán)資源實(shí)例詳情,返回結(jié)果中的記錄數(shù)不超過(guò)100。
POST https://{endpoint}/v2/{project_id}/cloudvolumes/resource_instances/action { "offset" : 100, "limit" : 100, "action" : "filter", "tags" : [ { "key" : "key1", "values" : [ "value1", "value2" ] } ], "matches" : [ { "key" : "resource_name", "value" : "resource1" }, { "key" : "service_type", "value" : "EVS" } ] }
響應(yīng)示例
狀態(tài)碼: 200
云硬盤(pán)信息。
{ "total_count" : 1, "resources" : [ { "resource_name" : "resource1", "resource_detail" : { "attachments" : [ { "server_id" : "2080869e-ba46-4ea5-b45e-3191ac0f1d54", "attachment_id" : "1335f039-7a42-4d1e-be49-ac584db0ba0b", "attached_at" : "2019-08-06T07:00:21.842812", "volume_id" : "7fa6b592-ac75-460d-a28a-bb17429d1eb2", "device" : "/dev/vda", "id" : "7fa6b592-ac75-460d-a28a-bb17429d1eb2" } ], "links" : [ { "href" : "https://volume.Region.dc1.domainname.com/v2/051375756c80d5eb2ff0c014498645fb/
volumes/7fa6b592-ac75-460d-a28a-bb17429d1eb2", "rel" : "self" }, { "href" : "https://volume.Region.dc1.domainname.com/051375756c80d5eb2ff0c014498645fb/
volumes/7fa6b592-ac75-460d-a28a-bb17429d1eb2", "rel" : "bookmark" } ], "availability_zone" : "kvmxen.dc1", "os-vol-host-attr:host" : "az21.dc1#2", "enterprise_project_id" : "0", "updated_at" : "2019-08-09T06:19:35.874737", "replication_status" : "disabled", "id" : "7fa6b592-ac75-460d-a28a-bb17429d1eb2", "size" : 40, "user_id" : "75f26e17348643bfb7718578b04635c2", "os-vol-tenant-attr:tenant_id" : "051375756c80d5eb2ff0c014498645fb", "service_type" : "EVS", "metadata" : { }, "status" : "in-use", "volume_image_metadata" : { "size" : "0", "__quick_start" : "False", "container_format" : "bare", "min_ram" : "0", "image_name" : "test-hua-centos7.3-0725", "image_id" : "c6c153a6-dde8-4bac-8e40-3d7619436934", "__os_type" : "Linux", "min_disk" : "20", "__support_kvm" : "true", "virtual_env_type" : "FusionCompute", "__description" : "", "__os_version" : "CentOS 7.3 64bit", "__os_bit" : "64", "__image_source_type" : "uds", "__support_xen" : "true", "file_format" : "zvhd2", "checksum" : "d41d8cd98f00b204e9800998ecf8427e", "__imagetype" : "gold", "disk_format" : "zvhd2", "__image_cache_type" : "Not_Cache", "__isregistered" : "true", "__image_location" : "192.149.46.200:5443:pcsimssouthchina:c6c153a6-dde8-4bac-8e40-3d7619436934", "__image_size" : "911269888", "__platform" : "CentOS" }, "description" : "", "multiattach" : false, "name" : "resource1", "bootable" : "true", "created_at" : "2019-08-06T06:59:03.056682", "volume_type" : "SAS", "shareable" : false }, "tags" : [ { "key" : "key1", "value" : "value1" }, { "key" : "key1", "value" : "value2" } ], "resource_id" : "7fa6b592-ac75-460d-a28a-bb17429d1eb2" } ] }
狀態(tài)碼: 400
Bad Request
{ "error" : { "message" : "XXXX", "code" : "XXX" } }
狀態(tài)碼
狀態(tài)碼 |
描述 |
---|---|
200 |
云硬盤(pán)信息。 |
400 |
Bad Request |
錯(cuò)誤碼
請(qǐng)參見(jiàn)錯(cuò)誤碼。