FailoverDiskReplicaGroup -

Enables the failover feature for replication pairs in a replication pair-consistent group. If the primary disks of specific replication pairs in a replication pair-consistent group fail, you can call this operation to enable the read and write permissions on the secondary disks.

Usage notes

For information about the regions in which the replication pair-consistent group feature is available, see Overview.
The replication pair-consistent group must be in the One-time Syncing (manual_syncing), Syncing (syncing), Normal (normal), Stopping (stopping), Stop Failed (stop_failed), Stopped (stopped), In Failover (failovering), Failover Failed (failover_failed), or Failovered (failovered) state.
After a failover is performed, the replication pair-consistent group enters the Failovered (failovered) state.
Before you perform a failover, make sure that the first full data synchronization is complete between the primary site and the secondary site.

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	FailoverDiskReplicaGroup	The operation that you want to perform. Set the value to FailoverDiskReplicaGroup.
RegionId	String	Yes	cn-shanghai	The region ID of the secondary site of the replication pair-consistent group.
ReplicaGroupId	String	Yes	group-myreplica****	The ID of the replication pair-consistent group.
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)://ecs.aliyuncs.com/?Action=FailoverDiskReplicaGroup
&RegionId=cn-shanghai
&ReplicaGroupId=group-myreplica****
&ClientToken=123e4567-e89b-12d3-a456-42665544****
&<Common request parameters>

Sample success responses

XML format

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

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

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.NoPairInGroup	The operation is not allowed because no pair in the group.	The operation is not supported because no replication pairs belong to the specified replication pair-consistent group.
403	OperationDenied.PairGroupStatusConflict	The operation is not allowed due to pair and group status are not consistent.	The operation is not supported because the state of the replication pair is not the same as that of the replication pair-consistent group.
403	OperationDenied.PairGroupAZoneConflict	The operation is not allowed due to pair and group having different RegionId or ZoneId.	The operation is not supported because the replication pair-consistent group and the replication pair do not belong to the same region and zone.
403	OperationDenied.PairInAnotherGroup	The operation is not allowed because pair is already in another group.	The operation is not supported because the replication pair has been added to another replication pair-consistent group.
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.