Activate async replication by using StartDiskReplicaPair - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Operation description

Usage notes

For information about the regions in which async replication is available, see Overview.
Only replication pairs that are in the Created (created) or Stopped (stopped) state can be activated.
After a replication pair is activated, it enters the Initial Syncing (initial_syncing) state and the system performs the first asynchronous replication to replicate all data 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:StartDiskReplicaPair

update

*DiskReplicaPair

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the primary or secondary disk in the replication pair. You can call the DescribeDiskReplicaPairs operation to query the region information of replication pairs.	cn-beijing
ReplicaPairId	string	Yes	The ID of the replication pair.	pair-cn-dsa****
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token 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****
OneShot	boolean	No	Specifies whether to immediately synchronize data. Valid values: true: immediately synchronizes data. false: synchronizes data based on the recovery point objective (RPO). Default value: false.	false

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	A37597A6-BB99-19B3-85EA-4C2B91F0****

Examples

Success response

JSON format

{
  "RequestId": "A37597A6-BB99-19B3-85EA-4C2B91F0****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	OperationDenied.StandbyDeviceAttached	The secondary disk is attached.	The secondary disk is attached to the instance at the secondary site. Stop the instance or detach the disk from the instance.
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.ManualSyncLimit	One shot start manual syncing too frequently, please try again later.	The requirements of the cooldown period after manual synchronization operations are not met.
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.