MigrateToOtherZone - Tair (Redis® OSS-Compatible) - Alibaba Cloud ドキュメントセンター

Tair (Redis OSS-compatible) インスタンスを同一リージョン内の他のゾーンへ移行します。

操作説明

この操作を呼び出す前に、インスタンスのパブリックエンドポイント（存在する場合）をリリースする必要があります。詳細については、「ゾーン間でのインスタンス移行」をご参照ください。

説明

Tair (Redis OSS-compatible) インスタンスのネットワークタイプをクラシックネットワークから Virtual Private Cloud (VPC) に変更した場合、クラシックネットワークのエンドポイントが保持されているときは、そのクラシックネットワークエンドポイントが有効期限切れとなってリリースされた後にのみ、ゾーン間移行が可能です。
インスタンスの移行後、エンドポイントは変更されませんが、仮想 IP アドレス (VIP) は変更されます。インスタンスへの接続には、VIP ではなくエンドポイントをご利用ください。

今すぐお試しください

この 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:MigrateToOtherZone

update

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	Tair (Redis OSS-compatible) インスタンスの ID。	r-bp1zxszhcgatnx****
ZoneId	string	必須	移行先のプライマリゾーンの ID。ゾーン ID を照会するには、DescribeZones 操作を呼び出します。	cn-hangzhou-g
VSwitchId	string	任意	vSwitch の ID。説明 vSwitch が配置されるゾーンは、移行先ゾーンの ID と一致している必要があります。インスタンスのネットワークタイプが VPC の場合、このパラメーターは必須です。	vsw-bp1e7clcw529l773d****
EffectiveTime	string	任意	インスタンス移行後のデータベース切り替え時刻。有効な値は以下のとおりです。 Immediately：インスタンス移行直後にデータベースを切り替えます。 MaintainTime：メンテナンスウィンドウ内でデータベースを切り替えます。説明デフォルト値：Immediately。	Immediately
SecondaryZoneId	string	任意	インスタンスを移行するセカンダリゾーンの ID。ゾーン ID を照会するには、DescribeZones 操作を呼び出します。説明このパラメーターを指定すると、インスタンスのマスターノードおよびレプリカノードを異なるゾーンに配置でき、ゾーン間ディザスタリカバリを実現できます。これにより、データセンター単位の障害にも耐えられます。	cn-hangzhou-h
ReplicaCount	integer	任意	プライマリゾーン内のレプリカノード数。説明 ReplicaCount および SlaveReplicaCount パラメーターは、クラウドネイティブインスタンスにのみ適用されます。インスタンスをマルチゾーンへ移行する際、これらのパラメーターを使用して、インスタンスのプライマリゾーンおよびセカンダリゾーンにおけるレプリカノードのディストリビューションを調整できます。ただし、この操作ではノード数の増減はできません。したがって、`ReplicaCount および SlaveReplicaCount` の値の合計は、移行前と同一である必要があります。シングルゾーンからマルチゾーンへインスタンスを移行する際にこれらのパラメーターを指定しない場合、1 つのレプリカノードがセカンダリゾーンへ移行され、その他のすべてのレプリカノードはプライマリゾーンに残ります。インスタンスがクラスターインスタンスの場合、上記のパラメーターは、プライマリゾーンおよびセカンダリゾーン内の各シャードあたりのレプリカノード数を示します。	1
SlaveReplicaCount	integer	任意	セカンダリゾーン内のレプリカノード数。	1
ReadOnlyCount	integer	任意	プライマリゾーン内の読み取り専用レプリカ数。説明 ReadOnlyCount および SlaveReadOnlyCount パラメーターは、読み書き分離が有効化されたクラウドネイティブインスタンスにのみ適用されます。インスタンスをマルチゾーンへ移行する際、これらのパラメーターを使用して、インスタンスのプライマリゾーンおよびセカンダリゾーンにおける読み取り専用レプリカのディストリビューションを調整できます。ただし、この操作ではノード数の増減はできません。したがって、`ReadOnlyCount および SlaveReadOnlyCount` の値の合計は、移行前と同一である必要があります。シングルゾーンからマルチゾーンへインスタンスを移行する際にこれらのパラメーターを指定しない場合、1 つの読み取り専用レプリカがセカンダリゾーンへ移行され、その他のすべての読み取り専用レプリカはプライマリゾーンに残ります。インスタンスがクラスターインスタンスの場合、上記のパラメーターは、プライマリゾーンおよびセカンダリゾーン内の各シャードあたりの読み取り専用レプリカ数を示します。	1
SlaveReadOnlyCount	integer	任意	セカンダリゾーン内の読み取り専用レプリカ数。	1

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID。	29B0BF34-D069-4495-92C7-FA6D9452****

例

成功レスポンス

JSONJSON

{
  "RequestId": "29B0BF34-D069-4495-92C7-FA6D9452****"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	NetworkType.NotSupport	Specified network type does not support this operation.
400	InstanceStatus.NotSupport	Instance status does not support this operation.
400	MissingSwitchId	VSwitchId is mandatory for this action.
400	IzNotSupportVpcError	Specify zone not support VPC.
400	InvalidReginAvzNotFound	Specified user does not find the region and zone.
400	ClusterNotSupport	The Specified cluster does not support.
400	InvalidVSwitchId.Mismatch	The Specified vSwitchId does not matched VPC.
400	InvalidIzNo.NotSupported	The Specified Zone does not supported.
500	VpcServiceError	Invoke VPC service failed.
500	ZoneMigrationError.StillingRunning	Zone migration task is still running.
404	DBInstanceNotFound	Specified instance does not exist.

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

変更履歴

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