すべてのプロダクト
Search

このプロダクト

    Tair (Redis® OSS-Compatible):SwitchInstanceHA

    ドキュメントセンター

    Tair (Redis® OSS-Compatible):SwitchInstanceHA

    最終更新日:Jun 26, 2026

    プライマリ/セカンダリのスイッチオーバー（ノードロールの切り替え）を実行します。この操作は、マルチゾーン Deployment シナリオにおけるディザスタリカバリドリルやアプリケーションの最寄りアクセスに使用できます。

    操作説明

    説明

    マルチゾーン Deployment シナリオにおけるアプリケーションの最寄りアクセスの詳細については、シナリオ例を参照してください。

    この操作を呼び出す場合、インスタンスは高可用性タイプまたはデュアルレプリカタイプである必要があります。

    この操作を呼び出すと、以下の影響があります:

    • ノードロールのスイッチオーバーがトリガーされると、切り替え中のデータノードは数秒間読み取り専用状態になり、一時的な切断が発生します。アプリケーションに再接続メカニズムがあることを確認してください。

    • インスタンスが切り替え中の状態にある間は、構成変更やゾーン移行などのインスタンスレベルの操作を実行できません。

    今すぐお試しください

    この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

    テスト

    RAM 認証

    下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

    • アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

    • API：アクションを具体的に実行するための API。

    • アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。

    • リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

      • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

      • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

    • 条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

    • 依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    kvstore:SwitchInstanceHA

    update

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    InstanceId

    string

    必須

    インスタンス ID。 DescribeInstances を呼び出してインスタンス ID をクエリできます。

    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

    例

    成功レスポンス

    JSONJSON

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

    エラーコード

    完全なリストについては、「エラーコード」をご参照ください。

    変更履歴

    完全なリストについては、「変更履歴」をご参照ください。