全部產品
Search

搜尋本產品

    ：SwitchDBInstanceHA - 切換執行個體中的主備節點

    文件中心

    ：SwitchDBInstanceHA - 切換執行個體中的主備節點

    更新時間：Dec 18, 2025

    切換MongoDB執行個體中的主備節點。

    介面說明

    調用本介面時，執行個體狀態要求為運行中。

    說明

    • 本介面適用於複本集執行個體和分區叢集執行個體，暫不支援單節點執行個體。

    • 複本集執行個體以執行個體為單位進行切換，分區叢集執行個體以 Shard 為單位進行切換。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    dds:SwitchDBInstanceHA

    none

    *Instance

    acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DBInstanceId

    string

    是

    執行個體 ID。

    dds-bpxxxxxxxx
    NodeId

    string

    否

    分區叢集執行個體中 Shard 節點的 ID。

    說明

    當 DBInstanceId 參數傳入的是分區叢集執行個體 ID 時，本參數必須傳入。

    d-bpxxxxxxxx
    RoleIds

    string

    否

    需要執行切換的角色 ID。您可以調用 DescribeRoleZoneInfo 介面擷取角色 ID 和節點角色資訊。

    說明

    • 角色 ID 以英文逗號（,）分隔，不傳入本參數則切換主備節點。

    • 當 DBInstanceId 參數傳入的是分區叢集執行個體 ID 時，執行切換的角色必須屬於同一 Shard 節點中。

    972xxxx,972xxxx
    SwitchMode

    integer

    否

    切換主備節點的時間點。取值：

    • 0：立即切換。

    • 1：在可營運時間段內切換。

    0

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    26BD4E5F-BDB4-47BA-B232-413AA78CFA8F

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "26BD4E5F-BDB4-47BA-B232-413AA78CFA8F"
}

    錯誤碼

    HTTP status code

    錯誤碼

    錯誤資訊

    描述
    400 InvalidSwitchType Specified Swtich Type is not valid.
    400 InvalidInstanceId Specified Instance ID is not valid.
    400 HaStatusNotSupport Current DB instance HA status does not support this operation.

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

    變更歷史

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