全部產品
Search

搜尋本產品

    PolarDB：FailoverDBCluster - 對叢集進行手動主備切換

    文件中心

    PolarDB：FailoverDBCluster - 對叢集進行手動主備切換

    更新時間：Dec 15, 2025

    對PolarDB叢集進行手動主備切換，可以指定一個唯讀節點為新的主節點。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    polardb:FailoverDBCluster

    update

    *dbcluster

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

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DBClusterId

    string

    是

    資料庫叢集 ID。

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

    string

    否

    將要切換為主節點的節點 ID，如果不填，則系統自動選舉。您可以通過介面 DescribeDBClusters 查詢節點 ID 等資訊。

    說明

    • 自動選舉主節點： 系統找出當前可以被選舉的所有隻讀節點。選擇優先順序最高的一個或多個唯讀節點。如果切換第一個節點失敗（例如，網路原因、複製狀態異常等），則會嘗試切換下一個，直至成功。

    • 當叢集為 PolarDB PostgreSQL 版（相容 Oracle）或 PolarDB PostgreSQL 版時，該參數必填；當叢集為 PolarDB MySQL 版時，該參數非必填。

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

    boolean

    否

    是否是故障切換後的回切至原主可用性區域，取值範圍如下：

    • true：是。

    • false：不是。

    false
    ClientToken

    string

    否

    用於保證請求的等冪性，防止重複提交請求。由用戶端產生該參數值，保證在不同請求間唯一，大小寫敏感、不超過 64 個 ASCII 字元。

    6000170000591aed949d0f54a343f1a4233c1e7d1c5******
    TargetZoneType

    string

    否

    是否是主可用性區域內主備切換，取值如下：

    • Primary：主可用性區域內主備切換。

    • Standby：切換至儲存熱備叢集。

    Primary

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

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

    樣本

    正常返回樣本

    JSON格式

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

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 HaStatusNotSupport Current DB instance HA status does not support this operation. 執行個體的HA狀態不支援該操作
    400 InvalidDBNodeId.Malformed The specified parameter DBNodeId is not valid. 指定的參數DBNodeId無效。
    400 InvalidDBType.Malformed The Specified DBType is not valid. 指定的資料庫類型無效.
    400 UnsupportHighFrequenceSwitchOver The instance has switch over too frequent within ten minutes. 當前切換過於頻繁，建議5分鐘後重試
    400 UnsupportWitchUnhealthyReplication The action is unsupported with unhealthy replication. 當前複製關係異常，不支援切換
    403 OperationDenied.DBNodeType The operation is not permitted due to type of node. 操作失敗，節點類型不允許此操作。
    403 OperationDenied.ClusterCategory The operation is not permitted due to cluster category. 該叢集不支援此產品系列。
    404 InvalidDBCluster.NotFound The DBClusterId provided does not exist in our records. 當前的記錄中不存在提供的DBClusterId。
    404 InvalidDBClusterId.Malformed The specified parameter DBClusterId is not valid. 指定的參數DBClusterId無效

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。