功能介紹
使用標(biāo)簽過濾實(shí)例 標(biāo)簽管理服務(wù)需要提供按標(biāo)簽過濾各服務(wù)實(shí)例并匯總顯示在列表中,需要各服務(wù)提供查詢能力
調(diào)試
您可以在API Explorer中調(diào)試該接口,支持自動認(rèn)證鑒權(quán)。API Explorer可以自動生成SDK代碼示例,并提供SDK代碼示例調(diào)試功能。
URI
POST /v3/{project_id}/vault/resource_instances/action
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
項目id |
請求參數(shù)
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
without_any_tag |
否 |
Boolean |
不包含任意一個標(biāo)簽,該字段為true時查詢所有不帶標(biāo)簽的資源,此時忽略 “tags”、“tags_any”、“not_tags”、“not_tags_any”字段。 |
|
tags |
否 |
包含標(biāo)簽。 tags不允許為空列表。 tags中最多包含10個key。 tags中key不允許重復(fù)。 tags中多個key之間是“與”的關(guān)系。 結(jié)果返回包含所有標(biāo)簽的資源列表,key之間是與的關(guān)系,key-value結(jié)構(gòu)中value是或的關(guān)系。 無過濾條件時返回全量數(shù)據(jù)。 |
|
|
tags_any |
否 |
包含任一標(biāo)簽。 tags不允許為空列表。 tags中最多包含10個key。 tags中key不允許重復(fù)。 結(jié)果返回包含任一標(biāo)簽的資源列表,key之間是或的關(guān)系,key-value結(jié)構(gòu)中value是或的關(guān)系。 無過濾條件時返回全量數(shù)據(jù)。 |
|
|
not_tags |
否 |
不包含標(biāo)簽。 tags不允許為空列表。 tags中最多包含10個key。 tags中key不允許重復(fù)。 結(jié)果返回不包含所有標(biāo)簽的資源列表,key之間是與的關(guān)系,key-value結(jié)構(gòu)中value是或的關(guān)系。 無過濾條件時返回全量數(shù)據(jù)。 |
|
|
not_tags_any |
否 |
不包含任一標(biāo)簽。 tags不允許為空列表。 tags中最多包含10個key。 tags中key不允許重復(fù)。 結(jié)果返回不包含任一標(biāo)簽的資源列表,key之間是或的關(guān)系,key-value結(jié)構(gòu)張value是或的關(guān)系。 無過濾條件時返回全量數(shù)據(jù)。 |
|
|
sys_tags |
否 |
僅op_service權(quán)限可以使用此字段做資源實(shí)例過濾條件。 目前TMS調(diào)用時只包含一個tag結(jié)構(gòu)體。
目前TMS調(diào)用時,key下面只包含一個value,0表示默認(rèn)企業(yè)項目。 sys_tags和租戶標(biāo)簽過濾條件(tags、tags_any、not_tags、not_tags_any)不能同時使用。 無sys_tags時按照tag接口處理,無tag過濾條件時返回全量數(shù)據(jù)。 sys_tags不能為空列表 |
|
|
limit |
否 |
String |
查詢記錄數(shù)(action為count時無此參數(shù))如果action為filter時,默認(rèn)為1000,limit最小值為1,limit最大值為1000, 不在范圍內(nèi)報錯。返回的結(jié)果中記錄數(shù)不超過limit。 |
|
offset |
否 |
String |
索引位置(action為count時無此參數(shù))如果action為filter時,默認(rèn)為0,offset最小值為0。返回的結(jié)果中第一條記錄為符合查詢條件的第offset+1條記錄。 |
|
action |
是 |
String |
操作標(biāo)識取值范圍為:"filter", "count"。如果是filter就是分頁查詢,如果是count只需按照條件將總條數(shù)返回即可 |
|
matches |
否 |
資源本身支持的查詢條件。 matches中key不允許重復(fù)。 數(shù)組長度最大值為 1,后續(xù)再擴(kuò)展。 數(shù)組長度:0 - 1 |
|
|
cloud_type |
否 |
String |
云類型 枚舉值:
|
|
object_type |
否 |
String |
資源類型 枚舉值:
|
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
key |
是 |
String |
鍵。 最大長度127個unicode字符。 不允許為空字符串。 前后的空格會被丟棄。 |
|
values |
是 |
Array of strings |
值列表。 values中最多包含10個value。 每個value最大長度255個unicode字符。前后的空格會被丟棄。 values中value不允許重復(fù)。 values中多個value之間是"或"的關(guān)系。 values允許為空列表,value允許為空字符串。 values如果為空列表,表示任意值。 *為系統(tǒng)保留字符,如果value是以*開頭表示按照*后面的值全模糊匹配,不能只傳入“*”。 |
響應(yīng)參數(shù)
狀態(tài)碼: 200
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
resources |
符合查詢條件的資源列表(action為count時無此參數(shù))。 |
|
|
total_count |
Integer |
符合查詢條件的資源總個數(shù) |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
resource_id |
String |
資源ID |
|
resource_detail |
資源詳情 |
|
|
tags |
標(biāo)簽列表 沒有標(biāo)簽?zāi)J(rèn)為空數(shù)字。 |
|
|
resource_name |
String |
資源名稱 |
|
sys_tags |
僅op_service權(quán)限才可以獲取此字段: 目前只包含一個resource_tag 結(jié)構(gòu)體。 key:_sys_enterprise_project_id value:企業(yè)項目id,0表示默認(rèn)企業(yè)項目 非op_service場景不能返回此字段。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
billing |
運(yùn)營信息 |
|
|
description |
String |
存儲庫自定義描述信息。 最小長度:0 最大長度:255 |
|
id |
String |
存儲庫ID |
|
name |
String |
存儲庫名稱 最小長度:1 最大長度:64 |
|
project_id |
String |
項目ID |
|
provider_id |
String |
存儲庫資源類型id |
|
resources |
存儲庫資源 |
|
|
tags |
存儲庫標(biāo)簽 |
|
|
enterprise_project_id |
String |
企業(yè)項目id,默認(rèn)為‘0’。 |
|
auto_bind |
Boolean |
是否自動綁定,默認(rèn)為false,不支持。 |
|
bind_rules |
綁定規(guī)則 |
|
|
user_id |
String |
用戶id |
|
created_at |
String |
創(chuàng)建時間,例如:"2020-02-05T10:38:34.209782" |
|
auto_expand |
Boolean |
是否開啟存儲庫自動擴(kuò)容能力(只支持按需存儲庫)。 |
|
smn_notify |
Boolean |
存儲庫smn 消息通知 開關(guān) 缺省值:true |
|
threshold |
Integer |
存儲庫容量閾值,已用容量占總?cè)萘窟_(dá)到此百分比即發(fā)送相關(guān)通知 最小值:1 最大值:100 缺省值:80 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
allocated |
Integer |
已分配容量,單位GB |
|
charging_mode |
String |
創(chuàng)建模式,按需:post_paid,包周期:pre_paid,默認(rèn)為post_paid |
|
cloud_type |
String |
公有云:public ;混合云:hybrid |
|
consistent_level |
String |
規(guī)格,崩潰一致性(crash_consistent)或應(yīng)用一致性(app_consistent) |
|
object_type |
String |
對象類型: 云服務(wù)器 (server), 云硬盤 (disk),文件系統(tǒng)(turbo), 云桌面 (workspace),VMware(vmware),關(guān)系型 數(shù)據(jù)庫 (rds),文件(file)。 |
|
order_id |
String |
訂單ID |
|
product_id |
String |
產(chǎn)品ID |
|
protect_type |
String |
保護(hù)類型:備份(backup)、復(fù)制(replication)。 |
|
size |
Integer |
容量,單位GB 最小值:1 最大值:10485760 |
|
spec_code |
String |
規(guī)格編碼。 云服務(wù)備份存儲庫:vault.backup.server.normal; 云硬盤備份 存儲庫:vault.backup.volume.normal;文件備份存儲庫:vault.backup.turbo.normal |
|
status |
String |
存儲庫狀態(tài) 枚舉值:
|
|
storage_unit |
String |
存儲庫桶名 |
|
used |
Integer |
已使用容量,單位MB |
|
frozen_scene |
String |
凍結(jié)場景 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
extra_info |
資源附加信息 |
|
|
id |
String |
待備份資源id |
|
name |
String |
待備份資源名稱 最小長度:0 最大長度:255 |
|
protect_status |
String |
保護(hù)狀態(tài) 枚舉值:
|
|
size |
Integer |
資源已分配容量,單位為GB |
|
type |
String |
待備份資源的類型: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo, OS:: Workspace ::DesktopV2 |
|
backup_size |
Integer |
副本大小 |
|
backup_count |
Integer |
副本數(shù)量 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
exclude_volumes |
Array of strings |
需要排除備份的卷id。僅在多盤備份特性中有效,排除不需要備份的磁盤。當(dāng)虛擬機(jī)新綁定磁盤時,也能繼續(xù)排除之前設(shè)置不用備份的卷。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
key |
String |
key不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。 key只能由中文,字母,數(shù)字,“-”,“_”組成。 |
|
value |
String |
value不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。 value只能由中文,字母,數(shù)字,“-”,“_”,“.”組成。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
key |
String |
鍵。 key最大長度為36個字符。 key不能為空字符串。 key前后空格會被丟棄。 key不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。 key只能由中文,字母,數(shù)字,“-”,“_”組成。 |
|
value |
String |
值。 添加標(biāo)簽時value值必選,刪除標(biāo)簽時value值可選。 value最大長度為43個字符。 value可以為空字符串。 value前后的空格會被丟棄。 value不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。 value只能由中文,字母,數(shù)字,“-”,“_”,“.”組成。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
key |
String |
鍵。 系統(tǒng)標(biāo)簽的key,從白名單中取,不能隨意定義。 目前僅支持 _sys_enterprise_project_id字段,對應(yīng) 的value為企業(yè)項目ID。 |
|
value |
String |
值。 目前僅會用到企業(yè)項目ID,其中默認(rèn)的企業(yè)項目ID為“0”。 |
狀態(tài)碼: 400
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
error_code |
String |
請參見錯誤碼。 |
|
error_msg |
String |
錯誤信息 |
請求示例
使用標(biāo)簽分頁查詢存儲庫資源實(shí)例。
POST https://{endpoint}/v3/{project_id}/vault/resource_instances/action
{
"tags" : [ {
"key" : "string",
"values" : [ "vaule" ]
} ],
"action" : "filter"
}
響應(yīng)示例
狀態(tài)碼: 200
OK
{
"total_count" : 7,
"resources" : [ {
"resource_id" : "e54f7854-8de8-4f98-acf1-65f330bfe877",
"resource_name" : "vault-7698-api-test",
"resource_detail" : {
"vault" : {
"id" : "e54f7854-8de8-4f98-acf1-65f330bfe877",
"name" : "vault-7698-api-test",
"description" : null,
"resources" : [ ],
"provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
"created_at" : "2023-04-21T08:20:43.021936",
"project_id" : "667230ba418f48f1996329f174693053",
"enterprise_project_id" : "0",
"auto_bind" : false,
"bind_rules" : { },
"auto_expand" : false,
"smn_notify" : true,
"threshold" : 80,
"user_id" : "0ae13f012b80d2d81f11c0129285d34b",
"billing" : {
"allocated" : 0,
"cloud_type" : "public",
"consistent_level" : "crash_consistent",
"frozen_scene" : null,
"charging_mode" : "pre_paid",
"order_id" : "CS23042116192E6CZ",
"product_id" : "00301-231151-0--0",
"protect_type" : "backup",
"object_type" : "server",
"spec_code" : "vault.backup.server.normal",
"used" : 0,
"storage_unit" : null,
"status" : "available",
"size" : 100
},
"tags" : [ ]
}
},
"tags" : [ ]
} ]
}
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
錯誤碼
請參見錯誤碼。
- 云數(shù)據(jù)庫 RDS 的實(shí)例類型有哪些
- 云數(shù)據(jù)庫 RDS for PostgreSQL只讀實(shí)例_PG只讀實(shí)例_華為云
- 免費(fèi)時序數(shù)據(jù)庫_時序數(shù)據(jù)庫influxdb場景_數(shù)據(jù)庫資源免費(fèi)領(lǐng)取_實(shí)時數(shù)據(jù)庫
- TaurusDB規(guī)格變更_包周期庫擴(kuò)容_變更CPU_存儲擴(kuò)容
- 免費(fèi)緩存數(shù)據(jù)庫_KV數(shù)據(jù)庫redis場景_云數(shù)據(jù)庫資源免費(fèi)領(lǐng)取_緩存數(shù)據(jù)庫2
最新文章
- 云數(shù)據(jù)庫 RDS 的實(shí)例存儲類型有哪些
- GaussDB查詢庫表_GaussDB查詢數(shù)據(jù)庫表_高斯數(shù)據(jù)庫查詢庫表-華為云
- GaussDB實(shí)例狀態(tài)_GaussDB數(shù)據(jù)庫實(shí)例狀態(tài)_高斯數(shù)據(jù)庫實(shí)例狀態(tài)_華為云
- 文檔數(shù)據(jù)庫服務(wù)DDS實(shí)例類型_MongoDB實(shí)例類型_華為云
- 分布式存儲是什么_數(shù)據(jù)庫分布式存儲_分布式存儲介紹
- RDS for MySQL數(shù)據(jù)庫實(shí)例是什么_創(chuàng)建mysql實(shí)例步驟_如何創(chuàng)建RDS for MySQL數(shù)據(jù)庫實(shí)例
