華為云計(jì)算 云知識(shí) 查詢指定存儲(chǔ)庫ShowVault
查詢指定存儲(chǔ)庫ShowVault

 

功能介紹

根據(jù)ID查詢指定存儲(chǔ)庫

調(diào)試

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

URI

GET /v3/{project_id}/vaults/{vault_id}

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

項(xiàng)目ID

vault_id

String

存儲(chǔ)庫ID

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

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

參數(shù)

是否必選

參數(shù)類型

描述

X-Auth-Token

String

用戶Token。 通過調(diào)用 IAM 服務(wù)獲取用戶Token接口獲?。憫?yīng)消息頭中X-Subject-Token的值)。

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

狀態(tài)碼: 200

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

參數(shù)

參數(shù)類型

描述

vault

Vault object

存儲(chǔ)庫查詢返回對(duì)象

表4 Vault

參數(shù)

參數(shù)類型

描述

billing

Billing object

運(yùn)營(yíng)信息

description

String

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

最小長(zhǎng)度:0

最大長(zhǎng)度:255

id

String

存儲(chǔ)庫ID

name

String

存儲(chǔ)庫名稱

最小長(zhǎng)度:1

最大長(zhǎng)度: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

表5 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é)場(chǎng)景

表6 ResourceResp

參數(shù)

參數(shù)類型

描述

extra_info

ResourceExtraInfo object

資源附加信息

id

String

待備份資源id

name

String

待備份資源名稱

最小長(zhǎng)度:0

最大長(zhǎng)度: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ù)量

表7 ResourceExtraInfo

參數(shù)

參數(shù)類型

描述

exclude_volumes

Array of strings

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

表8 Tag

參數(shù)

參數(shù)類型

描述

key

String

鍵。

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

key不能為空字符串。

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

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

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

value

String

值。

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

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

value可以為空字符串。

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

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

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

表9 VaultBindRules

參數(shù)

參數(shù)類型

描述

tags

Array of BindRulesTags objects

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

最小長(zhǎng)度:0

最大長(zhǎng)度:5

數(shù)組長(zhǎng)度:0 - 5

表10 BindRulesTags

參數(shù)

參數(shù)類型

描述

key

String

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

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

value

String

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

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

狀態(tài)碼: 404

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

參數(shù)

參數(shù)類型

描述

vault

Vault object

存儲(chǔ)庫查詢返回對(duì)象

表12 Vault

參數(shù)

參數(shù)類型

描述

billing

Billing object

運(yùn)營(yíng)信息

description

String

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

最小長(zhǎng)度:0

最大長(zhǎng)度:255

id

String

存儲(chǔ)庫ID

name

String

存儲(chǔ)庫名稱

最小長(zhǎng)度:1

最大長(zhǎng)度: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

表13 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é)場(chǎng)景

表14 ResourceResp

參數(shù)

參數(shù)類型

描述

extra_info

ResourceExtraInfo object

資源附加信息

id

String

待備份資源id

name

String

待備份資源名稱

最小長(zhǎng)度:0

最大長(zhǎng)度: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ù)量

表15 ResourceExtraInfo

參數(shù)

參數(shù)類型

描述

exclude_volumes

Array of strings

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

表16 Tag

參數(shù)

參數(shù)類型

描述

key

String

鍵。

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

key不能為空字符串。

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

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

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

value

String

值。

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

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

value可以為空字符串。

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

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

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

表17 VaultBindRules

參數(shù)

參數(shù)類型

描述

tags

Array of BindRulesTags objects

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

最小長(zhǎng)度:0

最大長(zhǎng)度:5

數(shù)組長(zhǎng)度:0 - 5

表18 BindRulesTags

參數(shù)

參數(shù)類型

描述

key

String

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

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

value

String

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

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

請(qǐng)求示例

查詢指定存儲(chǔ)庫。

GET  https://{endpoint}/v3/{project_id}/vaults/{vault_id}

響應(yīng)示例

狀態(tài)碼: 200

OK

{
  "vault" : {
    "id" : "2b076f26-391f-40fa-bf71-a798940faccf",
    "name" : "sdk-vault1595581958",
    "description" : null,
    "resources" : [ ],
    "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
    "created_at" : "2020-07-24T09:12:49.491874",
    "project_id" : "0605767b5780d5762fc5c0118072a564",
    "enterprise_project_id" : "0",
    "auto_bind" : true,
    "bind_rules" : { },
    "auto_expand" : false,
    "user_id" : "aa2999fa5ae640f28926f8fd79188934",
    "billing" : {
      "allocated" : 0,
      "cloud_type" : "public",
      "consistent_level" : "crash_consistent",
      "frozen_scene" : null,
      "charging_mode" : "post_paid",
      "order_id" : null,
      "product_id" : null,
      "protect_type" : "backup",
      "object_type" : "server",
      "spec_code" : "vault.backup.server.normal",
      "used" : 0,
      "storage_unit" : null,
      "status" : "available",
      "size" : 40
    },
    "tags" : [ {
      "key" : "fds",
      "value" : null
    } ]
  }
}

狀態(tài)碼

狀態(tài)碼

描述

200

OK

404

Not Found

錯(cuò)誤碼

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