FailoverDiskReplicaPair -

Enables the failover feature for a replication pair. If the primary disk in a replication pair fails, you can call this operation to grant read and write permissions on the secondary disk and fail over to the secondary disk.

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. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter	Type	Required	Example	Description
Action	String	Yes	FailoverDiskReplicaPair	The operation that you want to perform. Set the value to FailoverDiskReplicaPair.
RegionId	String	Yes	cn-shanghai	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 sub-feature must be enabled for the region where the secondary disk is located.
ReplicaPairId	String	Yes	pair-cn-dsa****	The ID of the replication pair.
ClientToken	String	No	123e4567-e89b-12d3-a456-42665544****	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.

Response parameters

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

Examples

Sample requests

http(s)://ebs.cn-shanghai.aliyuncs.com/?Action=FailoverDiskReplicaPair
&RegionId=cn-shanghai
&ReplicaPairId=pair-cn-dsa****
&ClientToken=123e4567-e89b-12d3-a456-42665544****
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<FailoverDiskReplicaPairResponse>
    <RequestId>C123F94F-4E38-19AE-942A-A8D6F44F****</RequestId>
</FailoverDiskReplicaPairResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

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

Error codes

HTTP status code	Error code	Error message	Description
403	OperationDenied	The operation is not allowed.	You cannot perform this operation.
403	OperationDenied.InvalidStatus	The operation is not allowed in current status.	You cannot perform this operation on the resource in the current state.
403	OperationDenied.OperateNotAllowedForPrimary	Operation is not allowed on the primary site.	You cannot perform this operation on the primary site.
403	OperationDenied.OperateNotAllowedForStandby	Operation is not allowed on the secondary site.	You cannot perform this operation on the secondary site.
403	Forbidden	User is not authorized to operate.	You do not have the permissions to perform this operation on the resource. Check the permissions of your account or contact your Alibaba Cloud account administrator.
403	Forbidden.Action	User is not authorized to operate this action.	You have no access to this operation. Check the permissions of your account or contact your Alibaba Cloud account administrator.
404	NoSuchResource	The specified resource does not exist.	The specified resource is not found.
500	InternalError	The request processing has failed due to some unknown error, exception or failure.	An internal error occurred.
504	RequestTimeout	The request is timeout, please try again later.	The request timed out. Try again later.

For a list of error codes, see Service error codes.