執行主從切換（即切換節點角色），可應用于容災演練、多可用區場景下的應用就近連接等需求。
接口說明
說明
關于多可用區場景下的應用就近連接的詳細說明，請參見場景示例。
調用本接口時，實例類型為高可用或雙副本。
調用本接口將產生下述影響：
- 觸發節點角色切換后，執行切換的數據節點將出現秒級的只讀狀態和連接閃斷，請確保您的應用具備重連機制。
- 實例處于切換中狀態時，您將無法執行實例級別的操作（例如變更配置、遷移可用區等）。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| kvstore:SwitchInstanceHA | update | *全部資源 * |
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| InstanceId | string | 是 | 實例 ID，可調用 DescribeInstances 獲取。 | r-bp1zxszhcgatnx**** |
| NodeId | string | 否 | 數據分片節點 ID，您可以調用 DescribeRoleZoneInfo 獲取 CustinsId 參數，多個數據分片節點 ID 之間使用英文逗號（,）分隔，如需指定所有節點請輸入 說明
當實例為集群或讀寫分離架構時，本參數才可用，且必填。
| 56****19,56****20 |
| SwitchMode | integer | 否 | 0 | |
| SwitchType | string | 是 | 切換模式，取值：
說明
您需要根據業務場景對數據、服務等方面的需求進行衡量，然后選取切換模式。
| AvailablePriority |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-07-20 | OpenAPI 描述信息更新 | 查看變更詳情 |