Enable read and write on secondary disks with FailoverDiskReplicaGroup - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Enables the failover feature for replication pairs in a replication pair-consistent group. When 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.

Operation description

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 completed between the primary site and secondary site.

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:FailoverDiskReplicaGroup

update

*DiskReplicaGroup

acs:ebs:{#regionId}:{#accountId}:diskreplicagroup/{#ReplicaGroupId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the secondary site of the replication pair-consistent group.	cn-shanghai
ReplicaGroupId	string	Yes	The ID of the replication pair-consistent group.	group-myreplica****
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 elements

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

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
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.NoPairInGroup	The operation is not allowed because no pair in the group.	The operation is not supported while the specified replication pair-consistent group has no replication pairs.
403	OperationDenied.PairGroupStatusConflict	The operation is not allowed due to pair and group status are not consistent.	The operation is not supported while 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 while 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 while the replication pair is added to another replication pair-consistent group.
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.
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.