全部產品
Search

搜尋本產品

    Tair (Redis® OSS-Compatible)：SwitchInstanceHA

    文件中心

    Tair (Redis® OSS-Compatible)：SwitchInstanceHA

    更新時間：Jun 26, 2026

    執行主備切換（即切換節點角色），可應用於容災演練、多可用區場景下的應用就近連線等需求。

    介面說明

    說明

    關於多可用區場景下的應用就近連線的詳細說明，請參見場景示例。

    呼叫本介面時，執行個體類型為高可用或雙副本。

    呼叫本介面將產生下述影響：

    • 觸發節點角色切換後，執行切換的資料節點將出現秒級的唯讀狀態和連線閃斷，請確保您的應用具備重連機制。

    • 執行個體處於切換中狀態時，您將無法執行執行個體級別的操作（例如變更配置、遷移可用區等）。

    調試

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

    調試

    授權資訊

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

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

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

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

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

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

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

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

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    kvstore:SwitchInstanceHA

    update

    *All Resource

    *

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    InstanceId

    string

    是

    執行個體 ID，可呼叫 DescribeInstances 取得。

    r-bp1zxszhcgatnx****
    NodeId

    string

    否

    資料分片節點 ID，您可以呼叫 DescribeRoleZoneInfo 取得 CustinsId 參數，多個資料分片節點 ID 之間使用英文逗號（,）分隔，如需指定所有節點請輸入all。

    說明

    當執行個體為叢集或讀寫分離架構時，本參數才可用，且必填。

    56****19,56****20
    SwitchMode

    integer

    否

    執行時間，取值：

    • 0：立即執行，預設值。

    • 1：在可維護時間段執行。

    說明

    您可以呼叫 ModifyInstanceMaintainTime 修改執行個體的可維護時間段。

    0
    SwitchType

    string

    否

    切換模式，取值：

    • ReliabilityPriority (預設值)：可靠性優先，確保主備同步無延遲時才執行主備切換，不會丟失資料。該模式在寫入量較大且持續存在同步延遲的場景下，可能會造成主備切換失敗。

    • AvailablePriority：可用性優先，不考慮主備延遲，立即執行主備切換，可能會丟失少量資料。

    說明

    您需要根據業務場景對資料、服務等方面的需求進行衡量，然後選取切換模式。

    枚舉值：

    • AvailablePriority :

      AvailablePriority

    • ReliabilityPriority :

      ReliabilityPriority

    ReliabilityPriority
    SourceNodeId

    string

    否

    分片原 MASTER 節點的節點 ID。

    52717408
    TargetNodeId

    string

    否

    切換後目標 MASTER 節點的節點 ID。

    52717403
    TargetShardName

    string

    否

    執行個體分片名。

    r-2zegk3jyxxxwixfo6c-db-1

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    RequestId

    string

    請求 ID。

    5D622714-AEDD-4609-9167-F5DDD3D1****
    TaskId

    string

    674546459

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "5D622714-AEDD-4609-9167-F5DDD3D1****",
  "TaskId": "674546459"
}

    錯誤碼

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

    變更歷史

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