功能介紹
查詢其他區(qū)域的存儲庫列表
調(diào)試
您可以在API Explorer中調(diào)試該接口,支持自動認(rèn)證鑒權(quán)。API Explorer可以自動生成SDK代碼示例,并提供SDK代碼示例調(diào)試功能。
URI
GET /v3/{project_id}/vaults/external
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
項目ID |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
cloud_type |
否 |
String |
云類型。取值為public和hybrid。 |
|
external_project_id |
是 |
String |
其他區(qū)域的項目ID |
|
limit |
否 |
Integer |
每頁顯示條目數(shù) 最小值:1 最大值:1000 |
|
objcet_type |
否 |
String |
資源類型 |
|
offset |
否 |
Integer |
偏移值 |
|
protect_type |
否 |
String |
保護類型。取值為backup,replication和hybrid。 |
|
region_id |
是 |
String |
區(qū)域ID |
|
vault_id |
否 |
String |
存儲庫ID,指定存儲ID時其他過濾條件不生效。 |
請求參數(shù)
無
響應(yīng)參數(shù)
狀態(tài)碼: 200
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
vaults |
存儲庫實例列表 |
|
|
count |
Integer |
存儲庫個數(shù) |
|
limit |
Integer |
每頁顯示的條目數(shù)量 最小值:1 最大值:1000 缺省值:1000 |
|
offset |
Integer |
偏移量,表示從此偏移量開始查詢 最小值:0 缺省值:0 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
billing |
運營信息 |
|
|
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 |
是否開啟存儲庫自動擴容能力(只支持按需存儲庫)。 |
|
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 |
保護類型:備份(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 |
保護狀態(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)虛擬機新綁定磁盤時,也能繼續(xù)排除之前設(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ù)字,“-”,“_”,“.”組成。 |
請求示例
GET /v3/{project_id}/vaults/external?external_project_id=68589cac08274b82b4e254268a3862d8®ion_id=cn-shenzhen-1
響應(yīng)示例
狀態(tài)碼: 200
OK
{
"count" : 1,
"vaults" : [ {
"provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
"name" : "vault-name",
"billing" : {
"status" : "available",
"used" : 5588,
"protect_type" : "replication",
"product_id" : null,
"order_id" : null,
"object_type" : "server",
"consistent_level" : "crash_consistent",
"storage_unit" : null,
"cloud_type" : "public",
"allocated" : 0,
"charging_mode" : "post_paid",
"spec_code" : "vault.replication.server.normal",
"size" : 10
},
"tags" : [ ],
"created_at" : "2019-04-08T11:06:25.765503",
"enterprise_project_id" : "876ae48d-cfb3-4aff-bb55-83167abd3876",
"project_id" : "68589cac08274b82b4e254268a3862d8",
"id" : "0ca3eb86-8800-46da-9c37-9d657a825274",
"resources" : [ ],
"description" : null
} ]
}
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
200 |
OK |
錯誤碼
請參見錯誤碼。
