文档首页/ 云备份 CBR/ API参考/ API/ 存储库/ 创建包周期存储库
更新时间：2024-12-12 GMT+08:00
编辑
查看PDF
分享

创建包周期存储库

功能介绍

创建包周期存储库

URI

POST /v3/{project_id}/vaults/order

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。
表3 请求Body参数

参数

是否必选

参数类型

描述

vault

是

VaultOrder object

存储库
表4 VaultOrder

参数

是否必选

参数类型

描述

name

否

String

存储库名称

最小长度：1

最大长度：64

billing

是

BillingCreate object

创建参数信息

resources

是

Array of ResourceCreate objects

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

description

否

String

描述

最小长度：0

最大长度：255

backup_policy_id

否

String

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

tags

否

Array of Tag objects

标签列表 tags不允许为空列表。 tags中最多包含10个key。 tags中key不允许重复。

enterprise_project_id

否

String

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

auto_bind

否

Boolean

是否支持自动挂载。

bind_rules

否

VaultBindRules object

自动挂载的规则

threshold

否

Integer

存储库阈值，百分比。

最小值：1

最大值：100

smn_notify

否

Boolean

当容量到达阈值，是否启用通知

parameters

否

VaultCreateParameters object

存储库订单联合参数

auto_expand

否

Boolean

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

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只能由中文，字母，数字，“-”，“_”，“.”组成。
表11 VaultCreateParameters

参数

是否必选

参数类型

描述

combined_order

否

CombinedOrder object

组合订单。
表12 CombinedOrder

参数

是否必选

参数类型

描述

combined_order_id

否

String

组合订单 ID

combined_order_ecs_num

否

Integer

组合订单中 ECS 服务器数量，当前批量最大为 500。

最小值：1

最大值：1000

combined_order_num

否

Integer

组合订单数量。

最小值：1

最大值：1000

响应参数

状态码： 200

表13 响应Body参数

参数

参数类型

描述

orders

Array of CbcOrderResult objects

订单详情

retCode

Integer

创建结果代码

0：成功

errText

String

创建结果信息

error_code

String

操作错误码

0：无错误
表14 CbcOrderResult

参数

参数类型

描述

cloudServiceId

String

云服务ID

orderId

String

订单ID

subscribeResult

Integer

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

resourceId

String

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

状态码： 400

表15 响应Body参数

参数

参数类型

描述

error_code

String

请参见错误码。

error_msg

String

错误信息

请求示例

  • 创建一个包周期云服务器备份存储库，存储库容量为80G，周期为一个月且绑定一个资源。

    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"
    } ]
  }
}

  • 创建一个包周期云服务器备份存储库，存储库容量阈值为80G，云服务器数量为5，周期为一个月同时绑定一个资源并添加标签。

    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" ]
      }
    } ]
  }
}

响应示例

状态码： 200

OK

{
  "orders" : [ {
    "orderId" : "CS2303030941NJJIW",
    "cloudServiceId" : "cbr",
    "subscribeResult" : 1,
    "resourceId" : "ef3bf6bb-1ffb-46c0-8b23-f935ded5024a"
  } ],
  "retCode" : 0,
  "errText" : "success",
  "error_code" : 0
}

状态码

状态码

描述

200

OK

400

Bad Request

错误码

请参见错误码。

父主题： 存储库

相关文档