華為云計(jì)算 云知識(shí) 查詢存儲(chǔ)庫資源實(shí)例ShowVaultResourceInstances
查詢存儲(chǔ)庫資源實(shí)例ShowVaultResourceInstances
時(shí)間: 2023-09-04 11:46:00
猜你想看：
實(shí)時(shí)語音識(shí)別 云服務(wù)器配置 CDN是什么意思 視頻點(diǎn)播加速 什么是云桌面

 

功能介紹

使用標(biāo)簽過濾實(shí)例 標(biāo)簽管理服務(wù)需要提供按標(biāo)簽過濾各服務(wù)實(shí)例并匯總顯示在列表中，需要各服務(wù)提供查詢能力

調(diào)試

您可以在API Explorer中調(diào)試該接口，支持自動(dòng)認(rèn)證鑒權(quán)。API Explorer可以自動(dòng)生成SDK代碼示例，并提供SDK代碼示例調(diào)試功能。

URI

POST /v3/{project_id}/vault/resource_instances/action

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

是

String

項(xiàng)目id

請(qǐng)求參數(shù)

表2 請(qǐng)求Body參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

without_any_tag

否

Boolean

不包含任意一個(gè)標(biāo)簽，該字段為true時(shí)查詢所有不帶標(biāo)簽的資源，此時(shí)忽略 “tags”、“tags_any”、“not_tags”、“not_tags_any”字段。

tags

否

Array of TagsReq objects

包含標(biāo)簽。

tags不允許為空列表。

tags中最多包含10個(gè)key。

tags中key不允許重復(fù)。

tags中多個(gè)key之間是“與”的關(guān)系。

結(jié)果返回包含所有標(biāo)簽的資源列表，key之間是與的關(guān)系，key-value結(jié)構(gòu)中value是或的關(guān)系。

無過濾條件時(shí)返回全量數(shù)據(jù)。

tags_any

否

Array of TagsReq objects

包含任一標(biāo)簽。

tags不允許為空列表。

tags中最多包含10個(gè)key。

tags中key不允許重復(fù)。

結(jié)果返回包含任一標(biāo)簽的資源列表，key之間是或的關(guān)系，key-value結(jié)構(gòu)中value是或的關(guān)系。

無過濾條件時(shí)返回全量數(shù)據(jù)。

not_tags

否

Array of TagsReq objects

不包含標(biāo)簽。

tags不允許為空列表。

tags中最多包含10個(gè)key。

tags中key不允許重復(fù)。

結(jié)果返回不包含所有標(biāo)簽的資源列表，key之間是與的關(guān)系，key-value結(jié)構(gòu)中value是或的關(guān)系。

無過濾條件時(shí)返回全量數(shù)據(jù)。

not_tags_any

否

Array of TagsReq objects

不包含任一標(biāo)簽。

tags不允許為空列表。

tags中最多包含10個(gè)key。

tags中key不允許重復(fù)。

結(jié)果返回不包含任一標(biāo)簽的資源列表，key之間是或的關(guān)系，key-value結(jié)構(gòu)張value是或的關(guān)系。

無過濾條件時(shí)返回全量數(shù)據(jù)。

sys_tags

否

Array of SysTags objects

僅op_service權(quán)限可以使用此字段做資源實(shí)例過濾條件。

目前TMS調(diào)用時(shí)只包含一個(gè)tag結(jié)構(gòu)體。

  • key： _sys_enterprise_project_id

  • values：企業(yè)項(xiàng)目id列表

目前TMS調(diào)用時(shí)，key下面只包含一個(gè)value，0表示默認(rèn)企業(yè)項(xiàng)目。

sys_tags和租戶標(biāo)簽過濾條件（tags、tags_any、not_tags、not_tags_any）不能同時(shí)使用。

無sys_tags時(shí)按照tag接口處理，無tag過濾條件時(shí)返回全量數(shù)據(jù)。

sys_tags不能為空列表

limit

否

String

查詢記錄數(shù)（action為count時(shí)無此參數(shù)）如果action為filter時(shí)，默認(rèn)為1000，limit最小值為1，limit最大值為1000, 不在范圍內(nèi)報(bào)錯(cuò)。返回的結(jié)果中記錄數(shù)不超過limit。

offset

否

String

索引位置（action為count時(shí)無此參數(shù)）如果action為filter時(shí)，默認(rèn)為0，offset最小值為0。返回的結(jié)果中第一條記錄為符合查詢條件的第offset+1條記錄。

action

是

String

操作標(biāo)識(shí)取值范圍為："filter", "count"。如果是filter就是分頁查詢，如果是count只需按照條件將總條數(shù)返回即可

matches

否

Array of Match objects

資源本身支持的查詢條件。

matches中key不允許重復(fù)。

數(shù)組長度最大值為 1，后續(xù)再擴(kuò)展。

數(shù)組長度：0 - 1

cloud_type

否

String

云類型

枚舉值：

  • public

  • hybrid

object_type

否

String

資源類型

枚舉值：

  • server

  • disk
表3 TagsReq

參數(shù)

是否必選

參數(shù)類型

描述

key

是

String

鍵。

最大長度127個(gè)unicode字符。

不允許為空字符串。

前后的空格會(huì)被丟棄。

values

是

Array of strings

值列表。

values中最多包含10個(gè)value。

每個(gè)value最大長度255個(gè)unicode字符。前后的空格會(huì)被丟棄。

values中value不允許重復(fù)。

values中多個(gè)value之間是"或"的關(guān)系。

values允許為空列表，value允許為空字符串。

values如果為空列表，表示任意值。

*為系統(tǒng)保留字符，如果value是以*開頭表示按照*后面的值全模糊匹配，不能只傳入“*”。
表4 SysTags

參數(shù)

是否必選

參數(shù)類型

描述

key

是

String

鍵。 系統(tǒng)標(biāo)簽的key，從白名單中取，不能隨意定義。 目前僅支持 _sys_enterprise_project_id字段，對(duì)應(yīng) 的value為企業(yè)項(xiàng)目ID。

values

是

Array of strings

值列表。 目前僅會(huì)用到企業(yè)項(xiàng)目ID，其中默 認(rèn)的企業(yè)項(xiàng)目ID為“0”。
表5 Match

參數(shù)

是否必選

參數(shù)類型

描述

key

是

String

鍵。 key取值范圍為："resource_name"，資源名稱

value

是

String

值。 最大長度255個(gè)字符。 key為"resource_name"時(shí)，value為空字符串時(shí)精確匹配，為非空字符串時(shí)模糊匹配。

響應(yīng)參數(shù)

狀態(tài)碼： 200

表6 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

resources

Array of TagResource objects

符合查詢條件的資源列表（action為count時(shí)無此參數(shù)）。

total_count

Integer

符合查詢條件的資源總個(gè)數(shù)
表7 TagResource

參數(shù)

參數(shù)類型

描述

resource_id

String

資源ID

resource_detail

InstancesResourceDetail object

資源詳情

tags

Array of Tag objects

標(biāo)簽列表 沒有標(biāo)簽?zāi)J(rèn)為空數(shù)字。

resource_name

String

資源名稱

sys_tags

Array of SysTag objects

僅op_service權(quán)限才可以獲取此字段：

目前只包含一個(gè)resource_tag 結(jié)構(gòu)體。

key：_sys_enterprise_project_id

value：企業(yè)項(xiàng)目id，0表示默認(rèn)企業(yè)項(xiàng)目

非op_service場景不能返回此字段。
表8 InstancesResourceDetail

參數(shù)

參數(shù)類型

描述

vault

Vault object

存儲(chǔ)庫
表9 Vault

參數(shù)

參數(shù)類型

描述

billing

Billing object

運(yùn)營信息

description

String

存儲(chǔ)庫自定義描述信息。

最小長度：0

最大長度：255

id

String

存儲(chǔ)庫ID

name

String

存儲(chǔ)庫名稱

最小長度：1

最大長度：64

project_id

String

項(xiàng)目ID

provider_id

String

存儲(chǔ)庫資源類型id

resources

Array of ResourceResp objects

存儲(chǔ)庫資源

tags

Array of Tag objects

存儲(chǔ)庫標(biāo)簽

enterprise_project_id

String

企業(yè)項(xiàng)目id，默認(rèn)為‘0’。

auto_bind

Boolean

是否自動(dòng)綁定，默認(rèn)為false，不支持。

bind_rules

VaultBindRules object

綁定規(guī)則

user_id

String

用戶id

created_at

String

創(chuàng)建時(shí)間,例如:"2020-02-05T10:38:34.209782"

auto_expand

Boolean

是否開啟存儲(chǔ)庫自動(dòng)擴(kuò)容能力（只支持按需存儲(chǔ)庫）。

smn_notify

Boolean

存儲(chǔ)庫smn 消息通知 開關(guān)

缺省值：true

threshold

Integer

存儲(chǔ)庫容量閾值，已用容量占總?cè)萘窟_(dá)到此百分比即發(fā)送相關(guān)通知

最小值：1

最大值：100

缺省值：80
表10 Billing

參數(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

對(duì)象類型： 云服務(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ù)備份存儲(chǔ)庫：vault.backup.server.normal； 云硬盤備份 存儲(chǔ)庫：vault.backup.volume.normal；文件備份存儲(chǔ)庫：vault.backup.turbo.normal

status

String

存儲(chǔ)庫狀態(tài)

枚舉值：

  • available

  • lock

  • frozen

  • deleting

  • error

storage_unit

String

存儲(chǔ)庫桶名

used

Integer

已使用容量，單位MB

frozen_scene

String

凍結(jié)場景
表11 ResourceResp

參數(shù)

參數(shù)類型

描述

extra_info

ResourceExtraInfo object

資源附加信息

id

String

待備份資源id

name

String

待備份資源名稱

最小長度：0

最大長度：255

protect_status

String

保護(hù)狀態(tài)

枚舉值：

  • available

  • error

  • protecting

  • restoring

  • removing

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ù)量
表12 ResourceExtraInfo

參數(shù)

參數(shù)類型

描述

exclude_volumes

Array of strings

需要排除備份的卷id。僅在多盤備份特性中有效，排除不需要備份的磁盤。當(dāng)虛擬機(jī)新綁定磁盤時(shí)，也能繼續(xù)排除之前設(shè)置不用備份的卷。
表13 VaultBindRules

參數(shù)

參數(shù)類型

描述

tags

Array of BindRulesTags objects

按tags過濾自動(dòng)綁定的資源

最小長度：0

最大長度：5

數(shù)組長度：0 - 5
表14 BindRulesTags

參數(shù)

參數(shù)類型

描述

key

String

key不能包含非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

key只能由中文，字母，數(shù)字，“-”，“_”組成。

value

String

value不能包含非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

value只能由中文，字母，數(shù)字，“-”，“_”，“.”組成。
表15 Tag

參數(shù)

參數(shù)類型

描述

key

String

鍵。

key最大長度為36個(gè)字符。

key不能為空字符串。

key前后空格會(huì)被丟棄。

key不能包含非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

key只能由中文，字母，數(shù)字，“-”，“_”組成。

value

String

值。

添加標(biāo)簽時(shí)value值必選，刪除標(biāo)簽時(shí)value值可選。

value最大長度為43個(gè)字符。

value可以為空字符串。

value前后的空格會(huì)被丟棄。

value不能包含非打印字符ASCII(0-31)，“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。

value只能由中文，字母，數(shù)字，“-”，“_”，“.”組成。
表16 SysTag

參數(shù)

參數(shù)類型

描述

key

String

鍵。 系統(tǒng)標(biāo)簽的key，從白名單中取，不能隨意定義。 目前僅支持 _sys_enterprise_project_id字段，對(duì)應(yīng) 的value為企業(yè)項(xiàng)目ID。

value

String

值。 目前僅會(huì)用到企業(yè)項(xiàng)目ID，其中默認(rèn)的企業(yè)項(xiàng)目ID為“0”。

狀態(tài)碼： 400

表17 響應(yīng)Body參數(shù)

參數(shù)

參數(shù)類型

描述

error_code

String

請(qǐng)參見錯(cuò)誤碼。

error_msg

String

錯(cuò)誤信息

請(qǐng)求示例

使用標(biāo)簽分頁查詢存儲(chǔ)庫資源實(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

錯(cuò)誤碼

請(qǐng)參見錯(cuò)誤碼。

 

猜你喜歡
查詢存儲(chǔ)庫資源實(shí)例ShowVaultResourceInstances

意見反饋

0/200

提交 取消

提交成功！非常感謝您的反饋，我們會(huì)繼續(xù)努力做到更好 反饋提交失??！請(qǐng)稍后重試！