Enable Cross-Region Backup Replication via Mirror Vault API - Cloud Backup - Alibaba Cloud - Cloud Backup

**[Deprecated]** Creates a replication target vault and configures cross-region replication. This API operation does not support cross-account replication and is deprecated. Use CreateVault and CreateVaultReplication instead for full capabilities.

Operation description

After the backup vault is created, its status is INITIALIZING, and an initialization task is automatically initiated. After the task succeeds, the vault status changes to CREATED.

Call this operation in the region where the replication target vault resides (VaultRegionId).

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

hbr:CreateReplicationVault

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
VaultRegionId	string	Yes	The region ID of the backup vault.	cn-shanghai
VaultName	string	Yes	The name of the backup vault. The name must be 1 to 64 characters in length.	mirrorvaultname
Description	string	No	The description of the backup vault. The description must be 0 to 255 characters in length.	description
VaultStorageClass	string	No	The storage class of the backup vault. The value can only be STANDARD, which indicates standard storage.	STANDARD
ReplicationSourceVaultId	string	Yes	The ID of the source vault.	v-*********************
ReplicationSourceRegionId	string	Yes	The region ID of the source vault.	cn-hangzhou
RedundancyType	string	No	The data redundancy storage method of the backup vault. Valid values: LRS: locally redundant storage (LRS). The data redundancy storage mechanism is used to store redundant copies of each object on multiple devices across multiple facilities within the same zone, ensuring data durability and availability in the event of hardware failure. ZRS: zone-redundant storage (ZRS). The multi-zone mechanism is used to distribute user data across three zones in the same region. If one zone becomes unavailable, the data can still be accessed normally.	LRS
EncryptType	string	No	The encryption type of the replication target vault. This parameter is valid only when VaultType is set to STANDARD. The encryption type must be the same as that of the source backup repository. Valid values: HBR_PRIVATE: fully managed by Cloud Backup. The built-in secret key encryption method of the backup service is used. KMS: uses a custom key from Alibaba Cloud Key Management Service (KMS) for encryption.	HBR_PRIVATE
KmsKeyId	string	No	The custom key or alias from Alibaba Cloud KMS. This parameter is required only when EncryptType is set to KMS.	alias/test

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E
VaultId	string	The ID of the backup vault.	v-*********************
Success	boolean	Indicates whether the request was successful. true: The request was successful. false: The request failed.	true
Code	string	The return code. A value of 200 indicates success.	200
Message	string	The returned message. The value "successful" is returned for successful requests. An error message is returned for failed requests.	successful
TaskId	string	The initialization task ID of the backup vault. You can call DescribeTask to query the task status.	t-*********************

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.