创建存储库CreateVault_存储库

华为云计算云知识创建存储库CreateVault

普惠上云 2核2G2M云服务器

38元/年

云服务器秒杀 X实例-4核8G5M

338元/年

Flexus L实例 2核2G3M云服务器

68元/年

网站搭建买3年送2年

1元/天

创建存储库CreateVault

时间: 2023-08-30 15:51:34

API网关云服务器云主机云计算弹性伸缩

猜你想看：

实时语音识别云服务器配置 CDN是什么意思视频点播加速什么是云桌面

功能介绍

创建存储库

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

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	绑定的备份资源，未在创建时绑定资源填[] 数组长度：0 - 255
tags	否	Array of Tag objects	标签列表 tags不允许为空列表。 tags中最多包含10个key。 tags中key不允许重复。
ent erp rise_project_id	否	String	企业项目ID，默认为‘0’。
auto_bind	否	Boolean	是否支持自动挂载。
bind_rules	否	VaultBindRules object	自动挂载的规则
auto_expand	否	Boolean	是否开启存储库自动扩容能力（只支持按需存储库）。
threshold	否	Integer	存储库容量阈值，已用容量占总容量达到此百分比，将根据 smn_notify 参数设置选择是否发送相关通知。默认值为：80 最大值：100 最小值：1 最小值：1 最大值：100 缺省值：80
smn_notify	否	Boolean	存储库smn 消息通知开关。默认值为 true。缺省值：true
backup_name_prefix	否	String	备份名称前缀，设置后该存储库自动备份产生的备份副本都将携带该备份名称前缀最小长度：0 最大长度：32
demand_billing	否	Boolean	存储库使用是否允许超出容量，只有创建包周期存储库时才允许该值为 true 缺省值：false

表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 最小值：10 最大值：10485760
charging_mode	否	String	创建模式，按需：post_paid，包周期：pre_paid，默认为post_paid 缺省值：post_paid
period_type	否	String	创建类型，charging_mode为pre_paid必填，按年(year)或者按月(month) 枚举值： year month
period_num	否	Integer	创建类型的数量，charging_mode为pre_paid必填
is_auto_renew	否	Boolean	到期后是否自动续期，默认不续期缺省值：false
is_auto_pay	否	Boolean	是否自动付费，默认为不自动付费缺省值：false
console_url	否	String	跳转URL 最小长度：1 最大长度：255

表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	名称最小长度：0 最大长度：255

表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 数组长度：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	存储库自定义描述信息。最小长度：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	是否开启存储库自动扩容能力（只支持按需存储库）。
smn_notify	Boolean	存储库smn消息通知开关缺省值：true
threshold	Integer	存储库容量阈值，已用容量占总容量达到此百分比即发送相关通知最小值：1 最大值：100 缺省值：80
errText	String	包周期创建错误信息
retCode	String	包周期订购结果
orders	Array of CbcOrderResult objects	包周期创建订单信息
backup_name_prefix	String	备份名称前缀最小长度：0 最大长度：32
demand_billing	Boolean	是否允许使用超出存储库容量缺省值：false
cbc_delete_count	Integer	存储库删除次数缺省值：0
frozen	Boolean	存储库是否冻结缺省值：false

**表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 最小值：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	冻结场景

**表14** ResourceResp
参数	参数类型	描述
extra_info	ResourceExtraInfo object	资源附加信息
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::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 数组长度：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&region=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

{
  "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" : {
        "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

错误码

请参见错误码。

上一篇：查询job的状态ShowJob 下一篇：查询service状态readCoreV1NamespacedServiceStatus

对象存储服务（Object Storage Service）是一款稳定、安全、高效、易用的云存储服务，具备标准Restful API接口，可存储任意数量和形式的非结构化数据。

功能介绍

调试

URI

请求参数

响应参数

请求示例

响应示例

状态码

错误码

对象存储服务 OBS

最新文章

更多内容

7*24

备案

专业服务

退订

建议反馈

售前咨询热线