全部产品
Search
文档中心

云备份:CreateReplicationVault - 创建镜像备份仓库

更新时间:Dec 26, 2024

创建一个镜像备份仓库。

接口说明

备份仓库创建后,状态为 INITIALIZING,并自动发起初始化任务。任务成功后,仓库状态为 CREATED。

请在镜像备份仓库所在地域(VaultRegionId)调用该方法。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
hbr:CreateReplicationVaultcreate
*全部资源
*

请求参数

名称类型必填描述示例值
VaultRegionIdstring

备份仓库所属的地域 ID。

cn-shanghai
VaultNamestring

备份仓库名称。长度为 1~64 个字符。

mirrorvaultname
Descriptionstring

备份仓库描述信息。长度为 0~255 个字符。

description
VaultStorageClassstring

备份仓库存储类型。取值仅为 STANDARD,表示标准存储。

STANDARD
ReplicationSourceVaultIdstring

源仓库 ID。

v-*********************
ReplicationSourceRegionIdstring

源仓库所属的地域 ID。

cn-hangzhou
RedundancyTypestring

备份仓库的数据冗余存储方式。取值包括:

  • LRS:标准存储-本地冗余(LRS)。采用数据冗余存储机制,将每个对象的不同冗余存储在同一个可用区内多个设施的多个设备上,确保硬件失效时的数据持久性和可用性。
  • ZRS:标准存储-同城冗余(ZRS)。采用多可用区(AZ)机制,将用户的数据分散存放在同一地域(Region)的 3 个可用区。当某个可用区不可用时,仍然能够保障数据的正常访问。
LRS
EncryptTypestring

镜像备份仓库加密类型,仅 VaultType 为 STANDARD 时有效,需与源端备份仓库加密类型保持一致,支持

  • HBR_PRIVATE:HBR 完全托管,使用备份服务自带加密方式。
  • KMS:使用阿里云 KMS 服务自定义密钥加密。
HBR_PRIVATE
KmsKeyIdstring

阿里云 KMS 服务自定义密钥 Key 或者 Alias,仅当 EncryptType=KMS 时必填。

alias/test

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
VaultIdstring

备份仓库 ID。

v-*********************
Successboolean

请求是否成功。

  • true 表示成功。
  • false 表示失败。
true
Codestring

返回码,200 表示成功。

200
Messagestring

返回信息描述,成功一般返回 successful,错误时会返回相应错误信息。

successful
TaskIdstring

备份仓库初始化任务 ID。 可以使用 DescribeTask 查询任务状态。

t-*********************

示例

正常返回示例

JSON格式

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

错误码

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

变更历史

变更时间变更内容概要操作
2024-07-29OpenAPI 入参发生变更查看变更详情