華為云計算 云知識 查詢存儲庫列表ListVault
查詢存儲庫列表ListVault

 

功能介紹

查詢存儲庫列表

調(diào)試

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

URI

GET /v3/{project_id}/vaults

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

項目ID

表2 Query參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

cloud_type

String

公有云:public ;混合云:hybrid

enterprise_project_id

String

企業(yè)項目id或all_granted_eps,all_granted_eps表示查詢用戶有權(quán)限的所有企業(yè)項目id

id

String

存儲庫ID

limit

Integer

每頁顯示條目數(shù),正整數(shù)

最小值:1

最大值:1000

name

String

存儲庫名稱

object_type

String

對象類型: 云服務(wù)器 (server), 云硬盤 (disk),文件系統(tǒng)(turbo), 云桌面 (workspace),VMware(vmware),關(guān)系型 數(shù)據(jù)庫 (rds),文件(file)。

offset

Integer

偏移值,正整數(shù)

policy_id

String

策略ID

protect_type

String

保護(hù)類型:備份(backup)、復(fù)制(replication)。

resource_ids

String

資源id,支持多資源,以英文逗號分割

status

String

狀態(tài)

請求參數(shù)

表3 請求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

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

參數(shù)

參數(shù)類型

描述

vaults

Array of Vault objects

存儲庫實例列表

count

Integer

存儲庫個數(shù)

limit

Integer

每頁顯示的條目數(shù)量

最小值:1

最大值:1000

缺省值:1000

offset

Integer

偏移量,表示從此偏移量開始查詢

最小值:0

缺省值:0

表5 Vault

參數(shù)

參數(shù)類型

描述

billing

Billing object

運營信息

description

String

存儲庫自定義描述信息。

最小長度:0

最大長度:255

id

String

存儲庫ID

name

String

存儲庫名稱

最小長度:1

最大長度:64

project_id

String

項目ID

provider_id

String

存儲庫資源類型id

resources

Array of ResourceResp objects

存儲庫資源

tags

Array of Tag objects

存儲庫標(biāo)簽

enterprise_project_id

String

企業(yè)項目id,默認(rèn)為‘0’。

auto_bind

Boolean

是否自動綁定,默認(rèn)為false,不支持。

bind_rules

VaultBindRules object

綁定規(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

表6 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

對象類型:云服務(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)

枚舉值:

  • available

  • lock

  • frozen

  • deleting

  • error

storage_unit

String

存儲庫桶名

used

Integer

已使用容量,單位MB

frozen_scene

String

凍結(jié)場景

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

表8 ResourceExtraInfo

參數(shù)

參數(shù)類型

描述

exclude_volumes

Array of strings

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

表9 Tag

參數(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ù)字,“-”,“_”,“.”組成。

表10 VaultBindRules

參數(shù)

參數(shù)類型

描述

tags

Array of BindRulesTags objects

按tags過濾自動綁定的資源

最小長度:0

最大長度:5

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

表11 BindRulesTags

參數(shù)

參數(shù)類型

描述

key

String

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

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

value

String

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

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

請求示例

查詢存儲庫列表。

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

響應(yīng)示例

狀態(tài)碼: 200

OK

{
  "vaults" : [ {
    "id" : "a335f9e1-1628-4c64-a7be-38656e5ec19c",
    "name" : "vault-8538",
    "description" : null,
    "resources" : [ ],
    "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
    "created_at" : "2020-09-04T06:57:37.343535",
    "project_id" : "0605767b5780d5762fc5c0118072a564",
    "enterprise_project_id" : "0",
    "auto_bind" : false,
    "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" : 100
    },
    "tags" : [ ]
  } ],
  "count" : 50
}

狀態(tài)碼

狀態(tài)碼

描述

200

OK

錯誤碼

請參見錯誤碼。