FailoverDBCluster - PolarDB - Alibaba Cloud Documentation Center

Performs a manual failover to promote a read-only node to the primary node in a PolarDB cluster.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:
- For mandatory resource types, indicate with a prefix of * .
- 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
polardb:FailoverDBCluster	update	*dbcluster `acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBClusterId	string	Yes	The ID of the cluster.	pc-**************
TargetDBNodeId	string	No	The ID of the read-only node that you want to promote to the primary node. You can call the DescribeDBClusters operation to query node information, such as node IDs. Note If you leave this parameter empty, the system selects one or more available read-only nodes that have the highest failover priority as candidate primary nodes. If the failover to the first read-only node fails due to network issues, abnormal replication status, or other reasons, the system attempts to fail over your applications to the next read-only node until the failover is successful. This parameter is required for PolarDB for Oracle and PolarDB for PostgreSQL clusters. This parameter is optional for PolarDB for MySQL clusters.	pi-***********
RollBackForDisaster	boolean	No	Specifies whether to switch back services to the original primary zone when the original primary zone recovers. true false	false
ClientToken	string	No	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. The token is case-sensitive.	6000170000591aed949d0f54a343f1a4233c1e7d1c5******
TargetZoneType	string	No	Whether it is a primary-standby switch within the primary availability zone, with the following values: Primary: Primary-standby switch within the primary availability zone. Standby: Switch to the storage hot backup cluster.	Primary

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	D0CEC6AC-7760-409A-A0D5-E6CD86******

Examples

Sample success responses

JSONformat

{
  "RequestId": "D0CEC6AC-7760-409A-A0D5-E6CD86******"
}

Error codes

HTTP status code	Error code	Error message	Description
400	HaStatusNotSupport	Current DB instance HA status does not support this operation.	The HA status of the instance does not support this operation.
400	InvalidDBNodeId.Malformed	The specified parameter DBNodeId is not valid.	The specified DBNodeId parameter is invalid.
400	InvalidDBType.Malformed	The Specified DBType is not valid.	The specified database type is invalid.
400	UnsupportHighFrequenceSwitchOver	The instance has switch over too frequent within ten minutes.	The current switch is too frequent, it is recommended to try again in 5 minutes.
400	UnsupportWitchUnhealthyReplication	The action is unsupported with unhealthy replication.	The current replication relationship is abnormal. Switching is not supported.
403	OperationDenied.DBNodeType	The operation is not permitted due to type of node.	The specified node type does not support this operation.
403	OperationDenied.ClusterCategory	The operation is not permitted due to cluster category.	This series is not supported by the cluster.
404	InvalidDBCluster.NotFound	The DBClusterId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.
404	InvalidDBClusterId.Malformed	The specified parameter DBClusterId is not valid.	The specified DBClusterId parameter is invalid.

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

Change history

Change time	Summary of changes	Operation
2024-08-20	The Error code has changed	View Change Details
2024-08-08	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-12-07	The Error code has changed. The request parameters of the API has changed	View Change Details
2023-09-12	The Error code has changed	View Change Details
2023-06-12	The Error code has changed	View Change Details
2022-06-10	The Error code has changed	View Change Details