CreateDiskReplicaPair - Elastic Compute Service - Alibaba Cloud Documentation Center

Creates a disk replication pair.

Operation description

Description

Async replication is a feature that provides cross-region data protection based on the data replication capabilities of Elastic Block Storage (EBS). The feature asynchronously replicates data from a disk in one region to a disk in another region for disaster recovery. You can use this feature to build disaster recovery capabilities for critical services, protect database data, and improve business continuity. The async replication feature is billed for bandwidth on a subscription basis.

Currently, the asynchronous replication feature is available only for Enhanced SSD (ESSD) disks and has certain limitations.

Before you create a replication pair, note the following:

Prepare a source disk (primary disk) and a destination disk (secondary disk). The source disk is the disk that you want to protect with disaster recovery, and the destination disk is the replication target. You can call the CreateDisk operation to create the disks.
The secondary disk must be in a different region from the primary disk. For more information about the regions that support asynchronous replication, see Overview of asynchronous replication for disks.
This operation creates a replication pair between the primary and secondary disks. After you create the pair, you must call the StartDiskReplicaPair operation to activate it. Activating the replication pair starts the periodic, cross-region data replication from the primary disk to the secondary disk.

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

ebs:CreateDiskReplicaPair

create

*DiskReplicaPair

acs:ebs:{#regionId}:{#accountId}:diskreplicapair/*

None

ram:CreateServiceLinkedRole

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the replication pair.	cn-shanghai
SourceZoneId	string	Yes	The zone ID of the source disk (primary disk).	cn-beijing-f
DiskId	string	Yes	The ID of the source disk (primary disk).	d-iq80sgp4d0xbk24q****
DestinationRegionId	string	Yes	The region ID of the destination disk (secondary disk). You can call the DescribeRegions operation to query the regions that support asynchronous replication.	cn-shanghai
DestinationDiskId	string	Yes	The ID of the destination disk (secondary disk).	d-sa1f82p58p1tdw9g****
DestinationZoneId	string	Yes	The zone ID of the destination disk (secondary disk).	cn-shanghai-e
PairName	string	No	The name of the replication pair. The name must be 2 to 128 characters in length. It must start with a letter and cannot start with `http://` or `https://`. It can contain letters, digits, colons (:), underscores (_), periods (.), and hyphens (-).	TestReplicaPair
Description	string	No	The description of the replication pair. The description must be 2 to 256 characters in length. It cannot start with `http://` or `https://`.	This is description.
ChargeType	string	No	The billing method of the replication pair. Valid values: PREPAY: subscription. POSTPAY: pay-as-you-go. Default value: POSTPAY.	PREPAY
Period	integer	No	The subscription duration of the replication pair. This parameter is required when `ChargeType` is set to PREPAY. The unit of the duration is specified by `PeriodUnit`. Valid values: 1, 2, 3, 6, 12, 24, 36, and 60.	1
PeriodUnit	string	No	The unit of the subscription duration. Valid value: Month.	Month
ClientToken	string	No	A client token to ensure the idempotence of the request. Generate a value from your client to make sure that the value is unique among different requests. The ClientToken parameter can contain only ASCII characters and cannot exceed 64 characters in length. For more information, see How to ensure idempotence.	123e4567-e89b-12d3-a456-42665544****
Bandwidth	integer	No	The bandwidth for asynchronous data replication between disks. The unit is Kbps. Valid values: 10240 20480 51200 102400 Default value: 10240. When ChargeType is set to POSTPAY, you cannot specify this parameter. The system uses a value of 0, which means that the bandwidth is dynamically allocated based on data writes.	10240
RPO	integer	No	The recovery point objective (RPO) of the replication pair. The unit is seconds. Currently, only 900 is supported.	900
ResourceGroupId	string	No	The ID of the resource group to which the replication pair belongs.	rg-acfmvs****
Tag	array<object>	No	The list of tags. You can specify up to 20 tags.
	object	No	The tag information.
Value	string	No	The value of the tag.	TestValue
Key	string	No	The key of the tag.	TestKey
EnableRtc	boolean	No	Specifies whether to enable replication time control (RTC). Valid values: false: Disables RTC. true: Enables RTC. Default value: false. Note If the replication pair is added to a replication group, the setting of this parameter is the same as that of the replication group.	true

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	C123F94F-4E38-19AE-942A-A8D6F44F****
ReplicaPairId	string	The ID of the replication pair.	pair-cn-dsa****
OrderId	string	The order ID.	123456****

Examples

Success response

JSON format

{
  "RequestId": "C123F94F-4E38-19AE-942A-A8D6F44F****",
  "ReplicaPairId": "pair-cn-dsa****",
  "OrderId": "123456****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IdempotentParameterMismatch	The specified parameter has changed while using an already used clientToken.	The request and a previous request contains the same client token but different parameters.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	An internal error has occurred.
403	OperationDenied	The operation is not allowed.	The operation is not supported.
403	OperationDenied.InvalidStatus	The operation is not allowed in current status.	The operation is not supported in the current state.
403	OperationDenied.QuotaExceed	The operation is not allowed due to quota exceed.	The quota for performing this operation has been exceeded.
403	LastTokenProcessing	The last token request is processing.	The value of clientToken is used in another request that is being processed. Try again later.
403	InvalidAccountStatus.NotEnoughBalance	Your account does not have enough balance.
403	Forbidden	User is not authorized to operate.	You are not authorized to manage the resource. Check the account permissions or contact the Alibaba Cloud account.
403	Forbidden.Action	User is not authorized to operate this action.	You are not authorized to perform this operation. Check the account permissions or contact the Alibaba Cloud account.
404	NoSuchResource	The specified resource does not exist.	The specified resource does not exist.
504	RequestTimeout	The request is timeout, please try again later.	The request has timed out. Try again later.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.