すべてのプロダクト
Search
ドキュメントセンター

Tair (Redis® OSS-Compatible):SwitchInstanceHA

最終更新日:Apr 01, 2026

マスター/レプリカのスイッチオーバーを実行してノードのロールを切り替えます。この操作は、ディザスタリカバリ訓練や、ゾーンをまたいでデプロイされたアプリケーションへの近接アクセスに適用できます。

操作説明

説明

ゾーンをまたいでデプロイされたアプリケーションへの近接アクセスの詳細については、「ノードロールの切り替え」をご参照ください。

インスタンスは、ローカルディスクを使用するコミュニティ版インスタンス、または Tair (Enterprise Edition) の DRAM ベースのインスタンスである必要があります。

この操作を呼び出すと、ご利用のインスタンスに次の影響があります:

  • インスタンス内のデータシャードが読み取り専用状態になり、数秒以内に一時的な切断が発生する場合があります。アプリケーションがインスタンスに自動的に再接続するように設定されていることを確認してください。

  • インスタンスがスイッチオーバー状態になると、このインスタンスを管理できなくなります。たとえば、インスタンスの構成を変更したり、インスタンスを別のゾーンに移行したりすることはできません。

今すぐお試しください

この 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。有効な値:

  • 0:すぐにスイッチオーバーを実行します。

  • 1:メンテナンスウィンドウ中にスイッチオーバーを実行します。

説明

Tair (Redis OSS-compatible) インスタンスのメンテナンスウィンドウを変更するには、ModifyInstanceMaintainTime 操作を呼び出します。

0

SwitchType

string

任意

スイッチオーバーモード。有効な値:

  • AvailablePriority:可用性を優先して、すぐにスイッチオーバーを実行します。マスターノードとレプリカノード間のデータ同期レイテンシーは考慮されません。これにより、データ損失が発生する可能性があります。

  • ReliabilityPriority:信頼性を優先してスイッチオーバーを実行します。マスターノードとレプリカノード間にデータ同期レイテンシーがないことを確認してください。これにより、データの整合性が保証されます。このモードは、大量のデータが書き込まれ、データ同期レイテンシーが常に存在するシナリオでは、スイッチオーバーが失敗する可能性があります。

説明

ビジネスシナリオに基づいてデータとサービスの要件を評価し、スイッチオーバーモードを選択する必要があります。

列挙値:

  • AvailablePriority :

    AvailablePriority

  • ReliabilityPriority :

    ReliabilityPriority

ReliabilityPriority

レスポンスフィールド

フィールド

説明

object

RequestId

string

リクエストの ID。

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

成功レスポンス

JSONJSON

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

エラーコード

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

変更履歴

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