调用CreateVault接口创建备份仓库-云备份-阿里云-云备份(Cloud Backup)-阿里云帮助中心

创建一个备份仓库。

接口说明

每个阿里云账号最多能创建 100 个备份仓库。
备份仓库创建后，状态为 INITIALIZING，并自动发起初始化任务。任务成功后，备份仓库状态为 CREATED。此时仓库才能用于备份任务。
重要请确保在使用该接口前，已充分了解云备份产品的收费方式和价格。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

hbr:CreateVault

create

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
VaultRegionId	string	是	备份仓库所属的地域 ID。	cn-shanghai
VaultName	string	是	备份仓库名称。长度为 1~64 个字符。	backupvaultname
Description	string	否	备份仓库描述信息。长度为 0~255 个字符。	description
VaultType	string	否	备份仓库类型。取值 STANDARD，表示普通仓库。 OTS_BACKUP，表示 OTS 备份库。枚举值： OTS_BACKUP : OTS 备份库 STANDARD : 普通仓库	STANDARD
VaultStorageClass	string	否	备份仓库存储类型。 STANDARD：表示标准存储。 ARCHIVE：已弃用。 COLD_ARCHIVE：已弃用。 IA：已弃用。	STANDARD
WormEnabled	boolean	否	是否开启备份锁定。	false
EncryptType	string	否	源端加密类型，仅 VaultType 为 STANDARD 或者 OTS_BACKUP 时有效，支持 HBR_PRIVATE：HBR 完全托管，使用备份服务自带加密方式。 KMS：使用阿里云 KMS 服务自定义密钥加密。枚举值： KMS : 使用阿里云 KMS 服务自定义密钥加密 HBR_PRIVATE : HBR 完全托管，使用备份服务自带加密方式	KMS
KmsKeyId	string	否	阿里云 KMS 服务自定义密钥 Key 或者 Alias，仅当 EncryptType=KMS 时必填。	alias/yzs-hhht
Replication	boolean	否	是否创建复制目标备份库	true

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
VaultId	string	备份仓库 ID。	v-*********************
Success	boolean	请求是否成功。 true：成功 false：失败	true
Code	string	返回码，200 表示成功。	200
Message	string	返回信息描述，成功一般返回 successful，错误时会返回相应错误信息。	successful
TaskId	string	备份仓库初始化任务 ID。可以使用 DescribeTask 查询任务状态。	t-*********************

示例

正常返回示例

JSON格式

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
  "VaultId": "v-*********************",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "TaskId": "t-*********************"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。