All Products
Search

This Product

    PolarDB:FailoverDBCluster

    Document Center

    PolarDB:FailoverDBCluster

    Last Updated:Aug 28, 2026

    Promotes a read-only node to primary in a PolarDB cluster through manual failover.

    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

    polardb:FailoverDBCluster

    update

    *dbcluster

    acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    DBClusterId

    string

    Yes

    The cluster ID.

    pc-**************
    TargetDBNodeId

    string

    No

    The ID of the read-only node to promote to primary. Call DescribeDBClusters to query node IDs.

    Note

    • If left empty, the system selects the read-only node with the highest failover priority. If that failover fails due to network issues or abnormal replication, the system tries the next candidate until successful.

    • Required for PolarDB for Oracle and PolarDB for PostgreSQL clusters. Optional for PolarDB for MySQL clusters.

    pi-***********
    RollBackForDisaster

    boolean

    No

    Specifies whether to switch back to the original primary zone after it recovers.

    • true

    • false

    false
    ClientToken

    string

    No

    A client-generated idempotency token. Must be unique across requests, ASCII-only, case-sensitive, and up to 64 characters.

    6000170000591aed949d0f54a343f1a4233c1e7d1c5******
    TargetZoneType

    string

    No

    The failover target zone type. Valid values:

    Primary: failover within the primary availability zone. Standby: failover to the storage hot backup cluster.

    Primary

    Response elements

    Element

    Type

    Description

    Example

    object

    RequestId

    string

    The request ID.

    D0CEC6AC-7760-409A-A0D5-E6CD86******

    Examples

    Success response

    JSON format

    {
  "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. Failovers are too frequent. 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. The cluster category does not support this operation.
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. The specified cluster ID does not exist.
    404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. The specified DBClusterId parameter is invalid.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.