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

Description

  • The async replication feature is supported in the China (Shanghai), China (Beijing), China (Heyuan), and China (Chengdu) regions.
  • 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 from 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-426655440000

The client token that is used to ensure the idempotence of the request. You can use the client to generate the value, but you must make sure that it 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-A8D6F44F0450

The ID of the request.

Examples

Sample requests

https://ebs.cn-shanghai.aliyuncs.com/?Action=FailoverDiskReplicaPair
&RegionId=cn-shanghai
&ReplicaPairId=pair-cn-dsa****
&<Common request parameters>

Sample success responses

XML format

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

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

JSON format

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

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

Error codes

For a list of error codes, visit the API Error Center.