功能介紹
創(chuàng)建包周期存儲庫
調(diào)試
您可以在API Explorer中調(diào)試該接口,支持自動認(rèn)證鑒權(quán)。API Explorer可以自動生成SDK代碼示例,并提供SDK代碼示例調(diào)試功能。
URI
POST /v3/{project_id}/vaults/order
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
項(xiàng)目ID |
請求參數(shù)
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用戶Token。 通過調(diào)用 IAM 服務(wù)獲取用戶Token接口獲?。憫?yīng)消息頭中X-Subject-Token的值)。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
name |
否 |
String |
存儲庫名稱 最小長度:1 最大長度:64 最小長度:1 最大長度:64 |
|
billing |
是 |
創(chuàng)建參數(shù)信息 |
|
|
resources |
是 |
綁定的備份資源,未在創(chuàng)建時(shí)綁定資源填[] 數(shù)組長度:0 - 256 |
|
|
description |
否 |
String |
描述 最小長度:0 最大長度:255 最小長度:0 最大長度:255 |
|
backup_policy_id |
否 |
String |
備份策略ID,不設(shè)置時(shí)為null,不自動備份。 |
|
tags |
否 |
標(biāo)簽列表 tags不允許為空列表。 tags中最多包含10個(gè)key。 tags中key不允許重復(fù)。 數(shù)組長度:1 - 10 |
|
|
enterprise_project_id |
否 |
String |
企業(yè)項(xiàng)目ID,默認(rèn)為‘0’。 |
|
auto_bind |
否 |
Boolean |
是否支持自動掛載。 |
|
bind_rules |
否 |
自動掛載的規(guī)則 |
|
|
threshold |
否 |
Integer |
存儲庫閾值,百分比。 最小值:1 最大值:100 |
|
smn_notify |
否 |
Boolean |
當(dāng)容量到達(dá)閾值,是否啟用通知 |
|
parameters |
否 |
存儲庫訂單聯(lián)合參數(shù) |
|
|
auto_expand |
否 |
Boolean |
是否開啟存儲庫自動擴(kuò)容能力(只支持按需存儲庫)。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
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)。 |
|
protect_type |
是 |
String |
保護(hù)類型:備份(backup)、復(fù)制(replication)。 |
|
size |
是 |
Integer |
容量,單位GB 最小值:10 最大值:10485760 |
|
charging_mode |
否 |
String |
創(chuàng)建模式,按需:post_paid,包周期:pre_paid,默認(rèn)為post_paid 缺省值:post_paid |
|
period_type |
否 |
String |
創(chuàng)建類型,charging_mode為pre_paid必填,按年(year)或者按月(month) 枚舉值:
|
|
period_num |
否 |
Integer |
創(chuàng)建類型的數(shù)量,charging_mode為pre_paid必填 |
|
is_auto_renew |
否 |
Boolean |
到期后是否自動續(xù)期,默認(rèn)不續(xù)期 缺省值:false |
|
is_auto_pay |
否 |
Boolean |
是否自動付費(fèi),默認(rèn)為不自動付費(fèi) 缺省值:false |
|
console_url |
否 |
String |
跳轉(zhuǎn)URL 最小長度:1 最大長度:255 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
extra_info |
否 |
資源附加信息 |
|
|
id |
是 |
String |
待備份資源id |
|
type |
是 |
String |
待備份資源的類型: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Native::Server, OS::Sfs::Turbo, OS:: Workspace ::DesktopV2 |
|
name |
否 |
String |
名稱 最小長度:0 最大長度:255 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
exclude_volumes |
否 |
Array of strings |
需要排除備份的卷id。僅在多盤備份特性中有效,排除不需要備份的磁盤。當(dāng)虛擬機(jī)新綁定磁盤時(shí),也能繼續(xù)排除之前設(shè)置不用備份的卷。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
key |
是 |
String |
鍵。 key最大長度為36個(gè)字符。 key不能為空字符串。 key前后空格會被丟棄。 key不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。 key只能由中文,字母,數(shù)字,“-”,“_”組成。 |
|
value |
是 |
String |
值。 添加標(biāo)簽時(shí)value值必選,刪除標(biāo)簽時(shí)value值可選。 value最大長度為43個(gè)字符。 value可以為空字符串。 value前后的空格會被丟棄。 value不能包含非打印字符ASCII(0-31),“=”,“*”,“<”,“>”,“\”,“,”,“|”,“/”。 value只能由中文,字母,數(shù)字,“-”,“_”,“.”組成。 |
響應(yīng)參數(shù)
狀態(tài)碼: 200
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
orders |
訂單詳情 |
|
|
retCode |
Integer |
創(chuàng)建結(jié)果代碼 0:成功 |
|
errText |
String |
創(chuàng)建結(jié)果信息 |
|
error_code |
String |
操作錯(cuò)誤碼 0:無錯(cuò)誤 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
cloudServiceId |
String |
云服務(wù)ID |
|
orderId |
String |
訂單ID |
|
subscribeResult |
Integer |
訂購結(jié)果,1:成功;0:失敗 |
|
resourceId |
String |
包周期資源預(yù)生成資源id。 |
狀態(tài)碼: 400
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
error_code |
String |
請參見錯(cuò)誤碼。 |
|
error_msg |
String |
錯(cuò)誤信息 |
請求示例
-
創(chuàng)建一個(gè)包周期 云服務(wù)器備份 存儲庫,存儲庫容量為80G,周期為一個(gè)月且綁定一個(gè)資源。
POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults/order { "vault" : { "name" : "vault_name", "billing" : { "consistent_level" : "app_consistent", "object_type" : "server", "protect_type" : "backup", "size" : 80, "charging_mode" : "pre_paid", "period_type" : "month", "period_num" : 1 }, "resources" : [ { "id" : "23a320a5-3efd-4568-b1aa-8dd9183cc64c", "type" : "OS::Nova::Server" } ] } } -
創(chuàng)建一個(gè)包周期云服務(wù)器備份存儲庫,存儲庫容量閾值為80G,云服務(wù)器數(shù)量為5,周期為一個(gè)月同時(shí)綁定一個(gè)資源并添加標(biāo)簽。
POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults/order { "vault" : { "name" : "123", "description" : "description", "backup_policy_id" : "70e9c916-7109-472d-94e7-120900e4ba61", "tags" : [ { "key" : "key", "value" : "value" } ], "auto_bind" : false, "threshold" : 80, "smn_notify" : true, "parameters" : { "combined_order" : { "combined_order_id" : "CS2303030959MR1IT", "combined_order_ecs_num" : 5, "combined_order_num" : 5 } }, "bind_rules" : { "tags" : [ { "key" : "bind_rules_key", "value" : "bind_rules_value" } ] }, "billing" : { "cloud_type" : "public", "is_auto_renew" : false, "is_auto_pay" : false, "console_url" : "https://www.com", "consistent_level" : "app_consistent", "object_type" : "server", "protect_type" : "backup", "size" : 80, "charging_mode" : "pre_paid", "period_type" : "month", "period_num" : 1 }, "resources" : [ { "id" : "8ef08ba1-81f7-4e41-ae49-d3e2fb0ba388", "type" : "OS::Nova::Server", "name" : "server_name", "extra_info" : { "exclude_volumes" : [ "1855eb9a-2b5e-4938-a9f0-aea08b6f9243" ] } } ] } }
響應(yīng)示例
狀態(tài)碼: 200
OK
{
"orders" : [ {
"orderId" : "CS2303030941NJJIW",
"cloudServiceId" : "cbr",
"subscribeResult" : 1,
"resourceId" : "ef3bf6bb-1ffb-46c0-8b23-f935ded5024a"
} ],
"retCode" : 0,
"errText" : "success",
"error_code" : "0"
}
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
200 |
OK |
|
400 |
Bad Request |
錯(cuò)誤碼
請參見錯(cuò)誤碼。
最新文章
- TaurusDB包周期容量變更_包周期庫擴(kuò)容_變更CPU_存儲擴(kuò)容
- TaurusDB規(guī)格變更_包周期庫擴(kuò)容_變更CPU_存儲擴(kuò)容
- 分布式存儲是什么_數(shù)據(jù)庫分布式存儲_分布式存儲介紹
- GaussDB行列混合存儲_GaussDB規(guī)劃存儲模型_高斯數(shù)據(jù)庫行列混合存儲-華為云
- RDS for MySQL數(shù)據(jù)庫實(shí)例是什么_創(chuàng)建mysql實(shí)例步驟_如何創(chuàng)建RDS for MySQL數(shù)據(jù)庫實(shí)例
- 文件存儲是什么_文件存儲類型_彈性文件存儲
