MigrateToOtherZone API によるインスタンスの別ゾーンへの移行 - MongoDB

操作説明

この操作はレプリカセットインスタンスにのみ適用され、スタンドアロンインスタンスまたはシャードクラスターインスタンスには適用されません。

説明

インスタンスのパブリックエンドポイントを申請した場合、まず ReleasePublicNetworkAddress 操作を呼び出してパブリックエンドポイントを解放する必要があります。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

dds:MigrateToOtherZone

update

*Instance

acs:dds:{#regionId}:{#accountId}:dbinstance/{#dbInstanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
InstanceId	string	必須	インスタンスの ID。説明インスタンスのネットワークタイプが VPC の場合、VSwitchId パラメーターを指定する必要があります。	dds-bp2658****
ZoneId	string	必須	ApsaraDB for MongoDB インスタンスの移行先ゾーンの ID。説明移行先ゾーンと移行元ゾーンは同じリージョンに属している必要があります。 DescribeRegions を呼び出してゾーン ID を照会できます。	cn-hangzhou-b
EffectiveTime	string	任意	インスタンスが移行先ゾーンに移行される時間。有効値： Immediately (デフォルト)：インスタンスはすぐに移行されます。 MaintainTime：インスタンスはメンテナンスウィンドウ中に移行されます。	Immediately
VSwitchId	string	任意	移行先ゾーンの vSwitch の ID。説明このパラメーターは、インスタンスのネットワークタイプが VPC の場合にのみ有効かつ必須です。	vsw-bp67ac****

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID。	0FDDC511-7252-4A4A-ADDA-5CB1BF63873D

例

成功レスポンス

JSONJSON

{
  "RequestId": "0FDDC511-7252-4A4A-ADDA-5CB1BF63873D"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	InvalidEffectiveTime.Malformed	Specified EffectiveTime is not valid.
400	MigrateDBInstanceError	Error in migrating available area or changing your vpc network. Please submit the work order for processing.

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

変更履歴

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