切換MongoDB實例中的主備節點。
接口說明
調用本接口時，實例狀態要求為運行中。
說明
本接口適用于副本集實例和分片集群實例，暫不支持單節點實例。
副本集實例以實例為單位進行切換，分片集群實例以 Shard 為單位進行切換。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| dds:SwitchDBInstanceHA | none |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 實例 ID。 | dds-bpxxxxxxxx |
| NodeId | string | 否 | 分片集群實例中 Shard 節點的 ID。 說明
當 DBInstanceId 參數傳入的是分片集群實例 ID 時，本參數必須傳入。
| d-bpxxxxxxxx |
| RoleIds | string | 否 | 需要執行切換的角色 ID。您可以調用 DescribeRoleZoneInfo 接口獲取角色 ID 和節點角色信息。 說明
| 972xxxx,972xxxx |
| SwitchMode | integer | 否 | 切換主備節點的時間點。取值：
| 0 |
返回參數
示例
正常返回示例
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. |
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-07-13 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |