華為云計算 云知識 創(chuàng)建存儲庫CreateVault
創(chuàng)建存儲庫CreateVault

 

功能介紹

創(chuàng)建存儲庫

調(diào)試

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

URI

POST /v3/{project_id}/vaults

表1 路徑參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

project_id

String

項目ID

請求參數(shù)

表2 請求Header參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

X-Auth-Token

String

用戶Token。 通過調(diào)用 IAM 服務獲取用戶Token接口獲取(響應消息頭中X-Subject-Token的值)。

表3 請求Body參數(shù)

參數(shù)

是否必選

參數(shù)類型

描述

vault

VaultCreate object

存儲庫創(chuàng)建參數(shù)

表4 VaultCreate

參數(shù)

是否必選

參數(shù)類型

描述

backup_policy_id

String

備份策略ID,不設置時為null,不自動備份。

billing

BillingCreate object

創(chuàng)建參數(shù)信息

description

String

描述

最小長度:0

最大長度:64

name

String

存儲庫名稱

最小長度:1

最大長度:64

resources

Array of ResourceCreate objects

綁定的備份資源,未在創(chuàng)建時綁定資源填[]

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

tags

Array of Tag objects

標簽列表 tags不允許為空列表。 tags中最多包含10個key。 tags中key不允許重復。

enterprise_project_id

String

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

auto_bind

Boolean

是否支持自動掛載。

bind_rules

VaultBindRules object

自動掛載的規(guī)則

auto_expand

Boolean

是否開啟存儲庫自動擴容能力(只支持按需存儲庫)。

threshold

Integer

存儲庫容量閾值,已用容量占總?cè)萘窟_到此百分比,將根據(jù) smn_notify 參數(shù)設置選擇是否發(fā)送相關通知。 默認值為:80 最大值:100 最小值:1

最小值:1

最大值:100

缺省值:80

smn_notify

Boolean

存儲庫smn 消息通知 開關。 默認值為 true。

缺省值:true

backup_name_prefix

String

備份名稱前綴,設置后該存儲庫自動備份產(chǎn)生的備份副本都將攜帶該備份名稱前綴

最小長度:0

最大長度:32

demand_billing

Boolean

存儲庫使用是否允許超出容量,只有創(chuàng)建包周期存儲庫時才允許該值為 true

缺省值:false

表5 BillingCreate

參數(shù)

是否必選

參數(shù)類型

描述

cloud_type

String

公有云:public ;混合云:hybrid

consistent_level

String

規(guī)格,崩潰一致性(crash_consistent)或應用一致性(app_consistent)

object_type

String

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

protect_type

String

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

size

Integer

容量,單位GB

最小值:10

最大值:10485760

charging_mode

String

創(chuàng)建模式,按需:post_paid,包周期:pre_paid,默認為post_paid

缺省值:post_paid

period_type

String

創(chuàng)建類型,charging_mode為pre_paid必填,按年(year)或者按月(month)

枚舉值:

  • year

  • month

period_num

Integer

創(chuàng)建類型的數(shù)量,charging_mode為pre_paid必填

is_auto_renew

Boolean

到期后是否自動續(xù)期,默認不續(xù)期

缺省值:false

is_auto_pay

Boolean

是否自動付費,默認為不自動付費

缺省值:false

console_url

String

跳轉(zhuǎn)URL

最小長度:1

最大長度:255

表6 ResourceCreate

參數(shù)

是否必選

參數(shù)類型

描述

extra_info

ResourceExtraInfo object

資源附加信息

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

表7 ResourceExtraInfo

參數(shù)

是否必選

參數(shù)類型

描述

exclude_volumes

Array of strings

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

表8 Tag

參數(shù)

是否必選

參數(shù)類型

描述

key

String

鍵。

key最大長度為36個字符。

key不能為空字符串。

key前后空格會被丟棄。

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

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

value

String

值。

添加標簽時value值必選,刪除標簽時value值可選。

value最大長度為43個字符。

value可以為空字符串。

value前后的空格會被丟棄。

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

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

表9 VaultBindRules

參數(shù)

是否必選

參數(shù)類型

描述

tags

Array of BindRulesTags objects

按tags過濾自動綁定的資源

最小長度:0

最大長度:5

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

表10 BindRulesTags

參數(shù)

是否必選

參數(shù)類型

描述

key

String

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

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

value

String

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

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

響應參數(shù)

狀態(tài)碼: 200

表11 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

vault

VaultCreateResource object

存儲庫查詢返回對象

表12 VaultCreateResource

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

存儲庫標簽

enterprise_project_id

String

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

auto_bind

Boolean

是否自動綁定,默認為false,不支持。

bind_rules

VaultBindRules object

綁定規(guī)則

user_id

String

用戶id

created_at

String

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

auto_expand

Boolean

是否開啟存儲庫自動擴容能力(只支持按需存儲庫)。

smn_notify

Boolean

存儲庫smn消息通知開關

缺省值:true

threshold

Integer

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

最小值:1

最大值:100

缺省值:80

errText

String

包周期創(chuàng)建錯誤信息

retCode

String

包周期訂購結(jié)果

orders

Array of CbcOrderResult objects

包周期創(chuàng)建訂單信息

backup_name_prefix

String

備份名稱前綴

最小長度:0

最大長度:32

demand_billing

Boolean

是否允許使用超出存儲庫容量

缺省值:false

cbc_delete_count

Integer

存儲庫刪除次數(shù)

缺省值:0

frozen

Boolean

存儲庫是否凍結(jié)

缺省值:false

表13 Billing

參數(shù)

參數(shù)類型

描述

allocated

Integer

已分配容量,單位GB

charging_mode

String

創(chuàng)建模式,按需:post_paid,包周期:pre_paid,默認為post_paid

cloud_type

String

公有云:public ;混合云:hybrid

consistent_level

String

規(guī)格,崩潰一致性(crash_consistent)或應用一致性(app_consistent)

object_type

String

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

order_id

String

訂單ID

product_id

String

產(chǎn)品ID

protect_type

String

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

size

Integer

容量,單位GB

最小值:1

最大值:10485760

spec_code

String

規(guī)格編碼。 云服務備份存儲庫: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é)場景

表14 ResourceResp

參數(shù)

參數(shù)類型

描述

extra_info

ResourceExtraInfo object

資源附加信息

id

String

待備份資源id

name

String

待備份資源名稱

最小長度:0

最大長度:255

protect_status

String

保護狀態(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。僅在多盤備份特性中有效,排除不需要備份的磁盤。當虛擬機新綁定磁盤時,也能繼續(xù)排除之前設置不用備份的卷。

表16 Tag

參數(shù)

參數(shù)類型

描述

key

String

鍵。

key最大長度為36個字符。

key不能為空字符串。

key前后空格會被丟棄。

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

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

value

String

值。

添加標簽時value值必選,刪除標簽時value值可選。

value最大長度為43個字符。

value可以為空字符串。

value前后的空格會被丟棄。

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

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

表17 VaultBindRules

參數(shù)

參數(shù)類型

描述

tags

Array of BindRulesTags objects

按tags過濾自動綁定的資源

最小長度:0

最大長度:5

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

表18 BindRulesTags

參數(shù)

參數(shù)類型

描述

key

String

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

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

value

String

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

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

表19 CbcOrderResult

參數(shù)

參數(shù)類型

描述

cloudServiceId

String

云服務ID

orderId

String

訂單ID

subscribeResult

Integer

訂購結(jié)果,1:成功;0:失敗

resourceId

String

包周期資源預生成資源id。

狀態(tài)碼: 400

表20 響應Body參數(shù)

參數(shù)

參數(shù)類型

描述

error_code

String

請參見錯誤碼。

error_msg

String

錯誤信息

請求示例

  • 創(chuàng)建一個云服務器存儲庫,存儲庫容量為100G,按需計費,且同時綁定資源和添加標簽。

    POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults
    
    {
      "vault" : {
        "backup_policy_id" : "6dd81d7d-a4cb-443e-b8ed-1af0bd3a261b",
        "billing" : {
          "cloud_type" : "public",
          "consistent_level" : "crash_consistent",
          "object_type" : "server",
          "protect_type" : "backup",
          "size" : 100,
          "charging_mode" : "post_paid",
          "is_auto_renew" : false,
          "is_auto_pay" : false,
          "console_url" : "https://console.demo.com/cbr/?
    agencyId=97fcd896b7914cb98f553a087232e243&region=testregion/cbr/manager/csbs/vaultList" }, "description" : "vault_description", "name" : "vault_name", "resources" : [ { "extra_info" : { "exclude_volumes" : [ "43a320a5-3efd-4568-b1aa-8dd9183cc64b" ] }, "id" : "23a320a5-3efd-4568-b1aa-8dd9183cc64c", "type" : "OS::Nova::Server" } ], "tags" : [ { "key" : "key01", "value" : "value01" } ], "enterprise_project_id" : "0" } }
  • 創(chuàng)建一個云硬盤備份存儲庫,存儲庫容量為40G,按需計費。

    POST https://{endpoint}/v3/f841e01fd2b14e7fa41b6ae7aa6b0594/vaults
    
    {
      "vault" : {
        "billing" : {
          "consistent_level" : "crash_consistent",
          "object_type" : "disk",
          "protect_type" : "backup",
          "size" : 40,
          "charging_mode" : "post_paid",
          "is_auto_renew" : false,
          "is_auto_pay" : false
        },
        "name" : "test",
        "resources" : [ ]
      }
    }

響應示例

狀態(tài)碼: 200

OK

{
  "vault" : {
    "provider_id" : "0daac4c5-6707-4851-97ba-169e36266b66",
    "description" : "vault_description",
    "tags" : [ {
      "value" : "value01",
      "key" : "key01"
    } ],
    "enterprise_project_id" : "0",
    "auto_bind" : false,
    "id" : "ad7627ae-5b0b-492e-b6bd-cd809b745197",
    "user_id" : "38d65be2ecd840d19046e239e841a734",
    "name" : "vault_name",
    "billing" : {
      "status" : "available",
      "used" : 0,
      "protect_type" : "backup",
      "order_id" : null,
      "object_type" : "server",
      "allocated" : 40,
      "spec_code" : "vault.backup.server.normal",
      "size" : 100,
      "cloud_type" : "public",
      "product_id" : null,
      "consistent_level" : "crash_consistent",
      "storage_unit" : null,
      "charging_mode" : "post_paid"
    },
    "created_at" : "2019-05-23T12:51:10.071232",
    "project_id" : "fc347bc64ccd4589ae52e4f44b7433c7",
    "resources" : [ {
      "name" : "ecs-b977-0002",
      "backup_size" : 0,
      "protect_status" : "available",
      "backup_count" : 0,
      "extra_info" : {
        "exclude_volumes" : [ "1855eb9a-2b5e-4938-a9f0-aea08b6f9243", "5a51e8b3-2f65-4045-896f-f8ffae14b064" ]
      },
      "type" : "OS::Nova::Server",
      "id" : "23a320a5-3efd-4568-b1aa-8dd9183cc64c",
      "size" : 40
    } ]
  }
}

狀態(tài)碼

狀態(tài)碼

描述

200

OK

400

Bad Request

錯誤碼

請參見錯誤碼。