文档首页/ 云备份 CBR/ API参考（吉隆坡区域）/ API/ 存储库/ 创建存储库

更新时间：2022-08-16 GMT+08:00

查看PDF

创建存储库

功能介绍

创建存储库

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	描述最小长度：0 最大长度：64
name	是	String	存储库名称最小长度：1 最大长度：64
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	自动挂载的规则

表5 BillingCreate
参数	是否必选	参数类型	描述
cloud_type	否	String	公有云: public
consistent_level	是	String	规格，崩溃一致性（crash_consistent）或应用一致性（app_consistent）
object_type	是	String	对象类型：云服务器（server），云硬盘（disk）。
protect_type	是	String	保护类型：备份（backup）。
size	是	Integer	容量，单位GB 最小值：1 最大值：10485760
charging_mode	否	String	创建模式，按需：post_paid 缺省值：post_paid
is_auto_renew	否	Boolean	到期后是否自动续期，默认不续期缺省值：false
is_auto_pay	否	Boolean	是否自动付费，默认为不自动付费缺省值：false
console_url	否	String	跳转URL 最小长度：1 最大长度：255

表6 ResourceCreate
参数	是否必选	参数类型	描述
id	是	String	待备份资源id
type	是	String	待备份资源的类型: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Sfs::Turbo
name	否	String	名称最小长度：0 最大长度：255

表7 VaultBindRules
参数	是否必选	参数类型	描述
tags	否	Array of Tag objects	按tags过滤自动绑定的资源

响应参数

状态码： 200

表8 响应Body参数
参数	参数类型	描述
vault	VaultCreateResource object	存储库查询返回对象

表9 VaultCreateResource
参数	参数类型	描述
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	企业项目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	是否开启存储库自动扩容能力。

**表10** Billing
参数	参数类型	描述
allocated	Integer	已分配容量，单位GB
charging_mode	String	创建模式，按需：post_paid
cloud_type	String	公有云: public
consistent_level	String	规格，崩溃一致性（crash_consistent）或应用一致性（app_consistent）
object_type	String	对象类型：云服务器（server），云硬盘（disk），文件系统（turbo）。
order_id	String	订单ID
product_id	String	产品ID
protect_type	String	保护类型：备份（backup）。
size	Integer	容量，单位GB 最小值：1 最大值：10485760
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	冻结场景

**表11** ResourceResp
参数	参数类型	描述
id	String	待备份资源id
name	String	待备份资源名称最小长度：0 最大长度：255
protect_status	String	保护状态枚举值： available error protecting restoring removing
size	Integer	资源已分配容量,单位为GB
type	String	待备份资源的类型: OS::Nova::Server, OS::Cinder::Volume, OS::Ironic::BareMetalServer, OS::Sfs::Turbo
backup_size	Integer	副本大小
backup_count	Integer	副本数量

**表12** VaultBindRules
参数	参数类型	描述
tags	Array of Tag objects	按tags过滤自动绑定的资源

状态码： 400

**表13** 响应Body参数
参数	参数类型	描述
error_code	String	请参见错误码。
error_msg	String	错误信息

请求示例

创建云服务器存储库且同时绑定资源和添加tag

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" : {
        "include_volumes" : [ {
          "id" : "73ee8446-bce7-4371-9650-b440b5f4c1d0",
          "os_version" : "CentOS 7.6 64bit"
        } ]
      },
      "id" : "23a320a5-3efd-4568-b1aa-8dd9183cc64c",
      "type" : "OS::Nova::Server"
    } ],
    "tags" : [ {
      "key" : "key01",
      "value" : "value01"
    } ],
    "enterprise_project_id" : "0"
  }
}

创建云硬盘存储库，只包含必备参数

 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

{
  "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" : {
        "include_volumes" : [ {
          "os_version" : "CentOS 7.6 64bit",
          "id" : "73ee8446-bce7-4371-9650-b440b5f4c1d0"
        } ]
      },
      "type" : "OS::Nova::Server",
      "id" : "23a320a5-3efd-4568-b1aa-8dd9183cc64c",
      "size" : 40
    } ]
  }
}

状态码

状态码	描述
200	OK
400	Bad Request

错误码

请参见错误码。

父主题： 存储库

上一篇：存储库

下一篇：查询指定存储库

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消