MigrateAvailableZone API によるインスタンスの可用ゾーンへの移行 - MongoDB

ApsaraDB for MongoDB インスタンスを特定のゾーンに移行します。

操作説明

この操作は、MongoDB 4.2 以前を実行するレプリカセットインスタンスとシャードクラスターインスタンスでのみ利用可能です。
ApsaraDB for MongoDB インスタンスにパブリックエンドポイントを申請している場合は、MigrateAvailableZone 操作を呼び出す前に、ReleasePublicNetworkAddress 操作を呼び出してパブリックエンドポイントをリリースする必要があります。
ApsaraDB for MongoDB インスタンスで TDE (透過的データ暗号化) が無効になっています。
ソースゾーンと移行先ゾーンが同じリージョンに属している必要があります。
移行先ゾーンに vSwitch が作成されていること。インスタンスが VPC にある場合、この前提条件を満たす必要があります。 vSwitch の作成方法の詳細については、「vSwitch の操作」をご参照ください。

今すぐお試しください

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

update

*Instance

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

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	インスタンスの ID。説明インスタンスが VPC にデプロイされている場合は、Vswitch パラメーターを指定する必要があります。	dds-bp1ece71ff2f****
ZoneId	string	必須	移行先ゾーンの ID。説明ソースゾーンと移行先ゾーンは同じリージョンに属している必要があります。 DescribeRegions 操作を呼び出してゾーン ID をクエリできます。	cn-hangzhou-b
Vswitch	string	任意	移行先ゾーンの vSwitch の ID。説明インスタンスが VPC にデプロイされている場合は、このパラメーターを指定する必要があります。	vsw-bp1buy0h9myt5i9e7****
EffectiveTime	string	任意	インスタンスが移行先ゾーンに移行される時間。有効な値： Immediately：インスタンスはすぐに移行先ゾーンに移行されます。 MaintainTime：インスタンスは、インスタンスのメンテナンスウィンドウ中に移行先ゾーンに移行されます。デフォルト値： Immediately。	Immediately
SecondaryZoneId	string	任意	移行先のセカンダリゾーンの ID。	cn-hangzhou-h
HiddenZoneId	string	任意	移行先の非表示ゾーンの ID。	cn-shanghai-n

レスポンスフィールド

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

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidEffectiveTime.Malformed	Specified EffectiveTime is not valid.
400	InsType.NotSupport	Specified instance type dose not support this operation.
400	IncorrectMasterDBInstanceState	The Master instance state does not support this operation.
400	NetworkTypeNotSupport	The network type does not support this operation.
400	OperationDenied.LockMode	The operation is not permitted when the instance locked.
400	InvalidIzNo.NotSupported	the Specified vpc Zone not supported.
400	IncorrectVswitchId	The specified parameter 'VSwitchId' is not valid.
400	InvalidRegion_Zone_NotFound	Specified Region does not exist in RDS.
400	VPCERROR.ALLOCATE_ERROR	Cannot Allocate the require vpcInstances.
400	ProxyError	The request processing has failed due to some unknown error, exception or failure.
400	DbInsertError	Database insert error.
400	UnsupportedDBTdeStatus	Specified DB TDEStatus does not support this operation.
400	InvalidZoneParam	The target zone and source zone cannot be the same.
400	MigrateDBInstanceError	Error in migrating available area or changing your vpc network. Please submit the work order for processing.
400	MinorVersionNotSupport	Instance's MinorVersion is not supported for this API.
404	InvalidDbInstanceId.NotFound	Specified instance does not exist.

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

変更履歴

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