文档首页 > > API参考> API> 存储库> 创建存储库

创建存储库

分享
更新时间: 2019/10/09 GMT+08:00

功能介绍

创建按需存储库

URI

POST /v3/{project_id}/vaults

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID

请求参数

表2 请求Body参数

参数

是否必选

参数类型

描述

vault

VaultCreate object

存储库创建参数

表3 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

auto_bind

Boolean

是否支持自动挂载。

表4 Tag

参数

是否必选

参数类型

描述

key

String

键。

key最大长度为36个字符。

key不能为空字符串。

key前后空格会被丢弃。

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

[hws]: key只能由中文,字母,数字,“-”,“_”组成。

[dt]: key只能由字母,数字,“_”,“-”组成。

value

String

值。

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

value最大长度为43个字符。

value可以为空字符串。

value前后的空格会被丢弃。

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

[hws]: value只能由中文,字母,数字,“-”,“_”,“.”组成。

[dt]: value只能由字母,数字,“_”,“-”组成。

表5 ResourceCreate

参数

是否必选

参数类型

描述

extra_info

ResourceExtraInfo object

资源附加信息

id

String

待备份资源id

type

String

待备份资源的类型,如:"OS::Nova::Server","OS::Ironic::BareMetalServer","OS::Cinder::Volume"

表6 ResourceExtraInfo

参数

是否必选

参数类型

描述

exclude_volumes

Array of strings

需要排除备份的卷id。仅虚拟机磁盘级备份有效

include_volumes

Array of ResourceExtraInfoIncludeVolumes objects

要备份的卷

表7 ResourceExtraInfoIncludeVolumes

参数

是否必选

参数类型

描述

id

String

卷ID

os_version

String

操作系统类型

表8 BillingCreate

参数

是否必选

参数类型

描述

cloud_type

String

云类型,公有云或者混合云

consistent_level

String

规格,崩溃一致性或应用一致性

object_type

String

对象类型

protect_type

String

保护类型,备份、复制

size

Integer

容量,单位GB

charging_mode

String

购买模式,post_paid或者pre_paid,默认为按需post_paid

period_type

String

购买类型,按年(year)或者按月(month)

period_num

Integer

购买数量,按月最大支持9个月,按年最大支持3年。

is_auto_renew

Boolean

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

is_auto_pay

Boolean

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

console_url

String

订购完成后跳转URL

extra_info

BillbingCreateExtraInfo object

订单扩展信息

表9 BillbingCreateExtraInfo

参数

是否必选

参数类型

描述

combined_order_id

String

组合购买ID,组合购买时必传。

combined_order_ecs_num

Integer

组合购买数量,组合购买时必填。

响应参数

状态码为 200 时:

表10 响应Body参数

参数

参数类型

描述

vault

VaultGet object

存储库查询返回对象

表11 VaultGet

参数

参数类型

描述

billing

Billing object

运营信息

description

String

描述

id

String

保管库ID

name

String

保管库名称

project_id

String

项目ID

provider_id

String

保管库类型

resources

Array of ResourceResp objects

存储库资源

tags

Array of Tag objects

存储库标签

enterprise_project_id

String

企业项目id

created_at

String

创建时间

updated_at

String

更新时间

表12 Tag

参数

参数类型

描述

key

String

键。

key最大长度为36个字符。

key不能为空字符串。

key前后空格会被丢弃。

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

[hws]: key只能由中文,字母,数字,“-”,“_”组成。

[dt]: key只能由字母,数字,“_”,“-”组成。

value

String

值。

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

value最大长度为43个字符。

value可以为空字符串。

value前后的空格会被丢弃。

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

[hws]: value只能由中文,字母,数字,“-”,“_”,“.”组成。

[dt]: value只能由字母,数字,“_”,“-”组成。

表13 ResourceResp

参数

参数类型

描述

extra_info

ResourceExtraInfo object

资源附加信息

id

String

待备份资源id

name

String

待备份资源名称

protect_status

String

保护状态

size

Integer

资源已分配容量

type

String

待备份资源的类型

表14 ResourceExtraInfo

参数

参数类型

描述

exclude_volumes

Array of strings

需要排除备份的卷id。仅虚拟机磁盘级备份有效

include_volumes

Array of ResourceExtraInfoIncludeVolumes objects

要备份的卷

表15 ResourceExtraInfoIncludeVolumes

参数

参数类型

描述

id

String

卷ID

os_version

String

操作系统类型

表16 Billing

参数

参数类型

描述

allocated

Integer

已分配容量,单位MB

charging_mode

String

计费模式

cloud_type

String

云类型,如公有云

consistent_level

String

备份规格

object_type

String

对象类型

order_id

String

订单ID

product_id

String

产品ID

protect_type

String

保护类型

size

Integer

容量,单位GB

spec_code

String

规格编码

status

String

保管库状态

storage_unit

String

存储库桶名

used

Integer

已使用容量,单位MB

状态码为 400 时:

表17 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误信息

请求示例

{
	"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",
			"period_type":"month",
			"period_num":1,
			"is_auto_renew":false,
			"is_auto_pay":false,
			"console_url":"https://console.demo.com/cbr/?agencyId=97fcd896b7914cb98f553a087232e243&region=southchina&locale=zh-cn#/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"
	}
}

响应示例

状态码为 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",
			"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.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
			}
		]
	}
}

状态码为 400 时:

{
	"error_code" : "string",
	"error_msg" : "string"
}

返回值

返回值

描述

200

OK

400

Bad Request

错误码

状态码

错误码

描述

解决方案

400

6100

存储库资源超出限制

减少存储库资源个数

400

6101

存储库大小超出限制

减小存储库大小

400

6102

存储库资源与类型不匹配

选择正确类型资源

400

6103

资源已经存在于其他存储库

不支持一个资源添加到不同存储库

400

6104

资源重复

删除重复资源

400

6205

资源在老服务已经产生备份

请先进行服务迁移

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区