All Products
Search

This Product

    PolarDB:FailoverDBCluster

    Document Center

    PolarDB:FailoverDBCluster

    Last Updated:Nov 07, 2023

    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.

    debugging

    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:
      • The required resource types are displayed in bold characters.
      • 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.
    OperationAccess levelResource typeCondition keyAssociated operation
    polardb:FailoverDBClusterWRITE
    • dbcluster
      acs:polardb:{#regionId}:{#accountId}:dbcluster/{#dbclusterId}
      none
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBClusterIdstringYes

    The ID of the cluster.

    		pc-**************
    TargetDBNodeIdstringNo

    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-***********
    ClientTokenstringNo

    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******

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    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 codeError codeError messageDescription
    400HaStatusNotSupportCurrent DB instance HA status does not support this operation.The HA status of the instance does not support this operation.
    400InvalidDBNodeId.MalformedThe specified parameter DBNodeId is not valid.The specified DBNodeId parameter is invalid.
    400InvalidDBType.MalformedThe Specified DBType is not valid.The specified database type is invalid.
    403OperationDenied.DBNodeTypeThe operation is not permitted due to type of node.The specified node type does not support this operation.
    403OperationDenied.ClusterCategoryThe operation is not permitted due to cluster category.This series is not supported by the cluster.
    404InvalidDBCluster.NotFoundThe DBClusterId provided does not exist in our records.The specified DBClusterId parameter does not exist in the current record.
    404InvalidDBClusterId.MalformedThe 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 timeSummary of changesOperation
    2023-09-12The error codes of the API operation change.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 400 change
      Error Codes 403 change
      Error Codes 404 change
    2023-06-12The error codes of the API operation change.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
      delete Error Codes: 404
      Added Error Codes: 403
    2022-06-10The error codes of the API operation change.see changesets
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 404
      Added Error Codes: 400