九游平台/ 云备份 cbr/ / / / 创建存储库
更新时间：2025-02-13 gmt 08:00

创建存储库-九游平台

功能介绍

创建存储库

uri

post /v3/{project_id}/vaults

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

string

项目id

请求参数

表2 请求header参数

参数

是否必选

参数类型

描述

x-auth-token

是

string

用户token。

通过调用iam服务获取用户token接口获取（响应消息头中x-subject-token的值）。
表3 请求body参数

参数

是否必选

参数类型

描述

vault

是

vaultcreate object

存储库创建参数
表4 vaultcreate

参数

是否必选

参数类型

描述

backup_policy_id

否

string

备份策略id，不设置时为null，不自动备份。

billing

是

billingcreate object

创建参数信息

description

否

string

描述

name

是

string

存储库名称

resources

是

array of resourcecreate objects

绑定的备份资源，未在创建时绑定资源填[]

tags

否

array of tag objects

标签列表

tags不允许为空列表。

tags中最多包含10个key。

tags中key不允许重复。

enterprise_project_id

否

string

企业项目id，默认为‘0’。

auto_bind

否

boolean

是否支持自动挂载。

bind_rules

否

vaultbindrules object

自动挂载的规则

auto_expand

否

boolean

是否开启存储库自动扩容能力（只支持按需存储库）。

threshold

否

integer

存储库容量阈值，已用容量占总容量达到此百分比，将根据 smn_notify 参数设置选择是否发送相关通知。

默认值为：80

最大值：100

最小值：1

smn_notify

否

boolean

存储库smn消息通知开关。

默认值为 true。

backup_name_prefix

否

string

备份名称前缀，设置后该存储库自动备份产生的备份副本都将携带该备份名称前缀

demand_billing

否

boolean

存储库使用是否允许超出容量，只有创建包周期存储库时才允许该值为 true

sys_lock_source_service

否

string

用于标识smb服务，您可以设置为smb或者空

locked

否

boolean

用于标识当前存储库是否已锁定，锁定的存储库不支持解锁。
表5 billingcreate

参数

是否必选

参数类型

描述

cloud_type

否

string

公有云:public ;混合云:hybrid

consistent_level

是

string

规格，崩溃一致性（crash_consistent）或应用一致性（app_consistent）

object_type

是

string

对象类型：云服务器（server），云硬盘（disk），文件系统（turbo），云桌面（workspace），vmware（vmware），关系型数据库（rds），文件（file）。

protect_type

是

string

保护类型：备份（backup）、复制(replication)。

size

是

integer

容量，单位gb

charging_mode

否

string

创建模式，按需：post_paid，包周期：pre_paid，默认为post_paid

period_type

否

string

创建类型，charging_mode为pre_paid必填

  • year: 按年

  • month: 按月

period_num

否

integer

创建类型的数量，charging_mode为pre_paid必填

is_auto_renew

否

boolean

到期后是否自动续期，默认不续期

is_auto_pay

否

boolean

是否自动付费，默认为不自动付费

console_url

否

string

跳转url

is_multi_az

否

boolean

存储库多az属性，默认为false
表6 resourcecreate

参数

是否必选

参数类型

描述

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

名称
表7 resourceextrainfo

参数

是否必选

参数类型

描述

exclude_volumes

否

array of strings

需要排除备份的卷id。仅在多盘备份特性中有效，排除不需要备份的磁盘。当虚拟机新绑定磁盘时，也能继续排除之前设置不用备份的卷。
表8 tag

参数

是否必选

参数类型

描述

key

是

string

键。

key最大长度为36个字符。

key不能为空字符串。

key前后空格会被丢弃。

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

key只能由中文，字母，数字，“-”，“_”组成。

value

是

string

值。

添加标签时value值必选，删除标签时value值可选。

value最大长度为43个字符。

value可以为空字符串。

value前后的空格会被丢弃。

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

value只能由中文，字母，数字，“-”，“_”，“.”组成。
表9 vaultbindrules

参数

是否必选

参数类型

描述

tags

否

array of bindrulestags objects

按tags过滤自动绑定的资源

最小长度：0

最大长度：5
表10 bindrulestags

参数

是否必选

参数类型

描述

key

是

string

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

key只能由中文，字母，数字，“-”，“_”组成。

value

是

string

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

value只能由中文，字母，数字，“-”，“_”，“.”组成。

响应参数

状态码：200

表11 响应body参数

参数

参数类型

描述

vault

vaultcreateresource object

存储库查询返回对象
表12 vaultcreateresource

参数

参数类型

描述

billing

billing object

运营信息

description

string

存储库自定义描述信息。

id

string

存储库id

name

string

存储库名称

project_id

string

项目id

provider_id

string

存储库资源类型id

resources

array of resourceresp objects

存储库资源

tags

array of tag objects

存储库标签

enterprise_project_id

string

企业项目id，默认为‘0’。

auto_bind

boolean

是否自动绑定，默认为false，不支持。

bind_rules

vaultbindrules object

绑定规则

user_id

string

用户id

created_at

string

创建时间,例如:"2020-02-05t10:38:34.209782"

auto_expand

boolean

是否开启存储库自动扩容能力（只支持按需存储库）。

smn_notify

boolean

存储库smn消息通知开关

threshold

integer

存储库容量阈值，已用容量占总容量达到此百分比即发送相关通知

errtext

string

包周期创建错误信息

retcode

string

包周期订购结果

orders

array of cbcorderresult objects

包周期创建订单信息

backup_name_prefix

string

备份名称前缀

demand_billing

boolean

是否允许使用超出存储库容量

cbc_delete_count

integer

存储库删除次数

frozen

boolean

存储库是否冻结

sys_lock_source_service

string

用于标识smb服务，您可以设置为smb或者空

locked

boolean

用于标识当前存储库是否已锁定，锁定的存储库不支持解锁。
表13 billing

参数

参数类型

描述

allocated

integer

已分配容量，单位gb

charging_mode

string

创建模式，按需：post_paid，包周期：pre_paid，默认为post_paid

cloud_type

string

公有云:public ;混合云:hybrid

consistent_level

string

规格，崩溃一致性（crash_consistent）或应用一致性（app_consistent）

object_type

string

对象类型：云服务器（server），云硬盘（disk），文件系统（turbo），云桌面（workspace），vmware（vmware），关系型数据库（rds），文件（file）。

order_id

string

订单id

product_id

string

产品id

protect_type

string

保护类型：备份（backup）、复制(replication)。

size

integer

容量，单位gb

spec_code

string

规格编码。

云服务备份存储库：vault.backup.server.normal；云硬盘备份存储库：vault.backup.volume.normal；文件备份存储库：vault.backup.turbo.normal

status

string

存储库状态

  • available: 可用

  • lock: 锁定

  • frozen: 冻结

  • deleting: 删除中

  • error: 异常

storage_unit

string

存储库桶名

used

integer

已使用容量，单位mb

frozen_scene

string

冻结场景

is_multi_az

boolean

存储库多az属性
表14 resourceresp

参数

参数类型

描述

extra_info

resourceextrainfo object

资源附加信息

id

string

待备份资源id

name

string

待备份资源名称

protect_status

string

保护状态

  • 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

副本数量
表15 resourceextrainfo

参数

参数类型

描述

exclude_volumes

array of strings

需要排除备份的卷id。仅在多盘备份特性中有效，排除不需要备份的磁盘。当虚拟机新绑定磁盘时，也能继续排除之前设置不用备份的卷。
表16 tag

参数

参数类型

描述

key

string

键。

key最大长度为36个字符。

key不能为空字符串。

key前后空格会被丢弃。

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

key只能由中文，字母，数字，“-”，“_”组成。

value

string

值。

添加标签时value值必选，删除标签时value值可选。

value最大长度为43个字符。

value可以为空字符串。

value前后的空格会被丢弃。

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

value只能由中文，字母，数字，“-”，“_”，“.”组成。
表17 vaultbindrules

参数

参数类型

描述

tags

array of bindrulestags objects

按tags过滤自动绑定的资源

最小长度：0

最大长度：5
表18 bindrulestags

参数

参数类型

描述

key

string

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

key只能由中文，字母，数字，“-”，“_”组成。

value

string

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

value只能由中文，字母，数字，“-”，“_”，“.”组成。
表19 cbcorderresult

参数

参数类型

描述

cloudserviceid

string

云服务id

orderid

string

订单id

subscriberesult

integer

订购结果，1：成功；0：失败

resourceid

string

包周期资源预生成资源id。

状态码：400

表20 响应body参数

参数

参数类型

描述

error_code

string

请参见。

error_msg

string

错误信息

请求示例

  • 创建一个云服务器存储库，存储库容量为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®ion=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"
  }
}

  • 创建一个云硬盘备份存储库，存储库容量为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" : [ ]
  }
}

响应示例

状态码：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",
      "object_type" : "server",
      "allocated" : 40,
      "spec_code" : "vault.backup.server.normal",
      "size" : 100,
      "cloud_type" : "public",
      "consistent_level" : "crash_consistent",
      "charging_mode" : "post_paid"
    },
    "created_at" : "2019-05-23t12:51:10.071 00:00",
    "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
    } ]
  }
}

状态码

状态码

描述

200

ok

400

bad request

错误码

请参见。

父主题：

相关文档

网站地图