FailoverDiskReplicaPair - Elastic Compute Service - Alibaba Cloud Documentation Center

Enables the failover feature for replication pairs.

Operation description

Usage notes

For information about the regions in which async replication is available, see Overview .
The replication pair for which you want to enable failover cannot be in the Invalid (invalid) or Deleted (deleted) state.
After a failover is performed, the replication pair enters the Failovered (failovered) state.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
ebs:FailoverDiskReplicaPair	update	DiskReplicaPair acs:ebs:{#regionId}:{#accountId}:diskreplicapair/{#ReplicaPairId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the secondary disk in the replication pair. You can call the DescribeDiskReplicaPairs operation to query region IDs of secondary disks in replication pairs. Note The failover feature must be enabled for the region where the secondary disk is located.	cn-shanghai
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****

Response parameters

Parameter	Type	Description	Example
	object	The schema of the response.
RequestId	string	The ID of the request.	C123F94F-4E38-19AE-942A-A8D6F44F****

Examples

Sample success responses

JSONformat

{
  "RequestId": "C123F94F-4E38-19AE-942A-A8D6F44F****"
}

Error codes

HTTP status code	Error code	Error message	Description
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.OperateNotAllowedForPrimary	Operation is not allowed on the primary site.	The operation is not allowed on the primary site.
403	OperationDenied.OperateNotAllowedForStandby	Operation is not allowed on the secondary site.	The operation is not allowed on the secondary site.
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.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	An internal error has occurred.
504	RequestTimeout	The request is timeout, please try again later.	The request has timed out. Try again later.

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-03-30	The Error code has changed	View Change Details