Performs a manual failover to promote a read-only node to the primary node in a PolarDB cluster.
Debugging
Authorization information
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
| pi-*********** |
| RollBackForDisaster | boolean | No | Specifies whether to switch back services to the original primary zone when the original primary zone recovers.
| 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
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 |