All Products
Search
Document Center

Hybrid Backup Recovery:CreateReplicationVault

Last Updated:Nov 14, 2022

Creates a backup vault.

Operation Description

After a backup vault is created, the backup vault is in the INITIALIZING state, and the system automatically runs an initialization task to initialize the backup vault. After the initialization task is completed, the backup vault is in the CREATED state.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
VaultRegionIdstringYes

The ID of the region where the backup vault resides.

cn-shanghai
VaultNamestringYes

The name of the backup vault. The name must be 1 to 64 characters in length.

mirrorvaultname
DescriptionstringNo

The description of the backup vault. The description must be 0 to 255 characters in length.

description
VaultStorageClassstringNo

The storage type of the backup vault. Valid value: STANDARD. The value indicates standard storage.

STANDARD
ReplicationSourceVaultIdstringYes

The ID of the source vault.

v-*********************
ReplicationSourceRegionIdstringYes

The ID of the region where the source vault resides.

cn-hangzhou
RedundancyTypestringNo

The data redundancy type of the backup vault. Valid values:

  • LRS: Locally redundant storage (LRS) is enabled for the backup vault. HBR stores the copies of each object on multiple devices of different facilities in the same zone. This way, HBR ensures data durability and availability even if hardware failures occur.
  • ZRS: Zone-redundant storage (ZRS) is enabled for the backup vault. HBR uses the multi-zone mechanism to distribute data across three zones within the same region. If a zone becomes unavailable, the data can still be accessed.
LRS

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

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

The ID of the backup vault.

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

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.
true
Codestring

The HTTP status code. The status code 200 indicates that the request was successful.

200
Messagestring

The message that is returned. If the request was successful, "successful" is returned. If the request failed, an error message is returned.

successful
TaskIdstring

The ID of the initialization task used to initialize the backup vault.

You can call the DescribeTask operation to query the status of an initialization task.

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

Example

Request example

http(s)://[Endpoint]/?Action=CreateReplicationVault
&VaultRegionId=cn-shanghai
&VaultName=mirrorvaultname
&Description=description
&VaultStorageClass=STANDARD
&ReplicationSourceVaultId=v-*********************
&ReplicationSourceRegionId=cn-hangzhou
&Common request parameters

Normal return example

JSONFormat

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

Error codes

For a list of error codes, visit the API error center.