创建包周期存储库 - CreatePostPaidVault

project_id

是

String

参数解释：

项目ID，获取方法请参见获取项目ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

X-Auth-Token

是

String

参数解释：

用户Token。

通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

vault

是

PrePaidVaultOrder object

参数解释：

存储库的具体规格，包括存储库的名称，容量等属性

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

name

否

String

参数解释：

存储库名称。

约束限制：

不涉及

取值范围：

只能由中文、字母、数字、“_”、“-”组成，最大支持64个字符。默认取值不涉及。

默认取值：

不涉及

billing

是

PrePaidBillingCreate object

参数解释：

创建存储库运营参数，包括存储库的大小，存储的资源的类型等属性

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

resources

是

Array of ResourceCreate objects

参数解释：

绑定的备份资源

约束限制：

不涉及

取值范围：

未在创建时绑定资源填[]，最大支持同时绑定255个资源

默认取值：

不涉及

description

否

String

参数解释：

存储库的描述

约束限制：

不涉及

取值范围：

最大支持255个字符，但不能包含“<”，“>”

默认取值：

不涉及

backup_policy_id

否

String

参数解释：

备份策略ID，用于指定自动备份时的备份策略，获取方法请参见获取备份策略ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

tags

否

Array of Tag objects

参数解释：

标签列表，标签由标签键和标签值组成，便于用户管理资源

约束限制：

tags中最多包含10个key。

• tags不允许为空列表。

• tags中key不允许重复。

取值范围：

不涉及

默认取值：

不涉及

enterprise_project_id

否

String

参数解释：

云备份企业项目ID，获取方法可参考查询企业项目列表接口。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

默认为‘0’

auto_bind

否

Boolean

参数解释：

是否支持自动挂载，开启时会根据挂载规则，自动绑定资源进行备份

约束限制：

不涉及

取值范围：

• true：支持自动挂载

• false：不支持自动挂载

默认取值：

false

bind_rules

否

VaultBindRules object

参数解释：

自动挂载的规则，可以设置根据标签自动绑定资源的规则

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

threshold

否

Integer

参数解释：

存储库容量阈值，存储库已用容量和总容量的百分比超过该值，如果smn_notify为开，将发送相关通知

约束限制：

不涉及

取值范围：

[1, 100]，单位为%

默认取值：

80

smn_notify

否

Boolean

参数解释：

是否发送smn通知开关

约束限制：

不涉及

取值范围：

• true：发送smn通知

• false：不发送smn通知

默认取值：

true

parameters

否

VaultCreateParameters object

参数解释：

存储库订单联合参数

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

auto_expand

否

Boolean

参数解释：

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

约束限制：

不涉及

取值范围：

true：支持自动扩容

false：不支持自动扩容

默认取值：

false

locked

否

Boolean

参数解释：

用于标识当前存储库是否已锁定，锁定的存储库不支持解锁，关于备份锁定的详细信息，请参考开启备份锁定

约束限制：

不涉及

取值范围：

• true：锁定存储库

• false：不锁定存储库

默认取值：

false

cloud_type

否

String

参数解释：

云类型

约束限制：

不涉及

取值范围：

public：公有云; hybrid: 混合云

默认取值：

public

consistent_level

是

String

参数解释：

存储库规格

约束限制：

不涉及

取值范围：

app_consistent: 应用一致性，crash_consistent: 崩溃一致性

默认取值：

不涉及

object_type

是

String

参数解释：

对象类型

约束限制：

不涉及

取值范围：

支持"server", "disk", "turbo", "workspace", "vmware", "rds"和"file"共七种。server：云服务器，disk：云硬盘，turbo：文件系统，workspace：云桌面，vmware：VMware，rds：关系型数据库，file：文件

默认取值：

不涉及

protect_type

是

String

参数解释：

保护类型

约束限制：

不涉及

取值范围：

backup：备份，replication：复制

默认取值：

不涉及

size

是

Integer

参数解释：

资源容量大小，单位GB

约束限制：

不涉及

取值范围：

10-10485760

默认取值：

不涉及

charging_mode

是

String

参数解释：

计费模式

约束限制：

不涉及

取值范围：

仅支持填写pre_paid：代表包年/包月模式

默认取值：

不涉及

period_type

是

String

参数解释：

订购周期单位

约束限制：

charging_mode参数为pre_paid时period_type参数会生效，并且period_type参数为必选

取值范围：

• month：月

• year：年

默认取值：

不涉及

period_num

是

Integer

参数解释：

订购周期数

约束限制：

charging_mode为pre_paid时period_num参数会生效，并且period_num参数为必选

取值范围：

[1-9]，代表定义一到九个周期

默认取值：

不涉及

is_auto_renew

否

Boolean

参数解释：

到期后是否自动续期

约束限制：

不涉及

取值范围：

• true：到期后自动续期

• false：到期后不自动续期

默认取值：

不涉及

is_auto_pay

否

Boolean

参数解释：

是否自动付费

约束限制：

不涉及

取值范围：

• true：下单后自动付费

• false：下单后不自动付费

默认取值：

false

console_url

否

String

参数解释：

云服务console_url。 订购订单支付完成后，客户可以通过此URL跳转到云服务Console页面查看信息

约束限制：

仅手动支付时涉及

取值范围：

不涉及

默认取值：

不涉及

is_multi_az

否

Boolean

参数解释：

存储库是否具有多AZ属性，即底层备份是否为多AZ备份

约束限制：

不涉及

取值范围：

• true：存储库具有多AZ属性

• false：存储库不具有多AZ属性

默认取值：

false

extra_info

否

ResourceExtraInfo object

参数解释：

资源附加信息，用于设置需要备份的卷以及不需要备份的卷等属性

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

id

是

String

参数解释：

待备份资源ID，获取方法请参见查询存储库绑定资源信息，查询资源可保护性

约束限制：

需要该资源暂未绑定到存储库中，且属于可备份的状态

取值范围：

不涉及

默认取值：

不涉及

type

是

String

参数解释：

待备份资源的类型，用于指定待备份的资源类型，不同类型对应不同的云服务资源。

约束限制：

不涉及

取值范围：

OS::Nova::Server：云服务器； OS::Cinder::Volume：云硬盘；OS::Ironic::BareMetalServer：裸金属服务器；OS::Sfs::Turbo：SFS Turbo文件系统；OS::Workspace::DesktopV2：云桌面。

默认取值：

不涉及

name

否

String

参数解释：

资源名称

约束限制：

不涉及

取值范围：

长度限制：0-255字符

默认取值：

不涉及

exclude_volumes

否

Array of strings

参数解释：

需要排除备份的卷ID列表，列表元素为String类型的UUID。

约束限制：

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

取值范围：

不涉及

默认取值：

不涉及

key

是

String

参数解释：

标签的键，用于标识和分类资源。

key最大长度为36个字符且不能为空字符串，前后空格会被丢弃。

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

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

创建时，如果请求体中存在重复key则报错，如果数据库存在就覆盖。

删除时，允许重复key，如果删除的标签不存在，默认处理成功,删除时不对标签字符集范围做校验。

删除时tags结构体不能缺失，key不能为空，或者空字符串。

取值范围：

不涉及

value

是

String

参数解释：

标签的值，用于描述存储库资源的具体属性。

添加标签时value必填，删除时选填，最大长度43字符且允许为空，前后空格会自动去除。此外，value不能包含非打印字符及= * < > \ , | /等特殊符号。

取值范围：

不涉及

tags

否

Array of BindRulesTags objects

参数解释：

按标签过滤自动绑定的资源

约束限制：

不涉及

取值范围：

最小长度：0

最大长度：5

默认取值：

不涉及

key

是

String

参数解释：

标签的键，用于标识和分类存储库资源

约束限制：

不涉及

取值范围：

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

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

默认取值：

不涉及

value

是

String

参数解释：

标签的值，与键配合使用，用于更精确地标识和分类存储库资源

约束限制：

不涉及

取值范围：

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

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

默认取值：

不涉及

combined_order

否

CombinedOrder object

参数解释：

组合订单，包括一起下订的订单信息

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

combined_order_id

否

String

参数解释：

组合订单ID

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

combined_order_ecs_num

否

Integer

参数解释：

组合订单中 ECS 服务器数量

约束限制：

不涉及

取值范围：

[1, 1000]

默认取值：

不涉及

combined_order_num

否

Integer

参数解释：

组合订单数量

约束限制：

不涉及

取值范围：

[1, 1000]

默认取值：

不涉及

orders

Array of CbcOrderResult objects

参数解释：

订单详情，包括订单ID，订购结果等信息

取值范围：

不涉及

retCode

Integer

参数解释：

创建结果代码

取值范围：

0：成功，其余表示创建失败

errText

String

参数解释：

创建结果信息

取值范围：

不涉及

error_code

String

参数解释：

操作错误码

取值范围：

0：无错误，其余为创建失败错误码

cloudServiceId

String

参数解释：

云服务ID

取值范围：

不涉及

orderId

String

参数解释：

订单ID

取值范围：

不涉及

subscribeResult

Integer

参数解释：

订购结果

取值范围：

1：成功；0：失败

resourceId

String

参数解释：

包周期资源预生成资源ID

取值范围：

不涉及

error_code

String

请参见错误码。

error_msg

String

错误信息

200

OK

400

Bad Request