MigrateToOtherZone - ApsaraDB RDS - Alibaba Cloud ドキュメントセンター

この API を使用して、RDS インスタンスを別のアベイラビリティゾーンに移行します。

操作説明

サポートされるエンジン

RDS MySQL
RDS PostgreSQL
RDS SQL Server

今すぐお試しください

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

rds:MigrateToOtherZone

update

*DBInstance

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

rds:ResourceTag

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
DBInstanceId	string	必須	インスタンス ID。`DescribeDBInstances` 操作を呼び出して、インスタンスの ID を照会できます。	rm-uf6wjk5****
VPCId	string	任意	VPC の ID。インスタンスを別のアベイラビリティゾーンに移行する際、インスタンスの VPC は変更できません。インスタンスが VPC に存在する場合、このパラメーターは必須です。インスタンスが SQL Server を実行している場合、移行中に VPC を変更できます。	vpc-****
ZoneId	string	必須	移行先のアベイラビリティゾーンの ID。`DescribeRegions` 操作を呼び出して、アベイラビリティゾーンの ID を照会できます。	cn-hangzhou-b
EffectiveTime	string	任意	移行が有効になる時刻。有効値： Immediate：移行はすぐに有効になります。これはデフォルト値です。 MaintainTime：移行はメンテナンスウィンドウ中に有効になります。詳細については、「`ModifyDBInstanceMaintainTime`」をご参照ください。 ScheduleTime：移行は指定した時刻に有効になります。説明このパラメーターを ScheduleTime に設定した場合、SwitchTime パラメーターも指定する必要があります。	Immediate
VSwitchId	string	任意	vSwitch の ID。インスタンスが VPC に存在する場合、このパラメーターは必須です。`DescribeVSwitches` 操作を呼び出して、利用可能な vSwitch を照会できます。 PostgreSQL または SQL Server を実行する RDS インスタンスの場合、マルチゾーン移行のために複数の vSwitch ID を指定できます。ID をコンマ (,) で区切り、vSwitch ID がアベイラビリティゾーンに対応していることを確認してください。	vsw-uf6adz52c2p****
Category	string	任意	インスタンスエディション。有効値： Basic：Basic Edition HighAvailability：High-availability Edition AlwaysOn：SQL Server 向け Cluster Edition cluster：MySQL 向け Cluster Edition Finance：Enterprise Edition (3 ノード)	HighAvailability
ZoneIdSlave1	string	任意	最初のセカンダリアベイラビリティゾーンの ID。説明このパラメーターは、Basic Edition を除くすべてのエディションのインスタンスで必須です。	cn-hangzhou-c
ZoneIdSlave2	string	任意	2 番目のセカンダリアベイラビリティゾーンの ID。説明このパラメーターは、Enterprise Edition (3 ノード) を実行するインスタンスにのみ適用されます。	cn-hangzhou-d
SwitchTime	string	任意	インスタンスを新しいアベイラビリティゾーンに切り替えるスケジュール時刻。時刻は yyyy-MM-ddTHH:mm:ssZ 形式で指定します。時刻は協定世界時 (UTC) である必要があります。説明このパラメーターは、EffectiveTime パラメーターを ScheduleTime に設定した場合にのみ必須です。	2021-12-14T15:15:15Z
IsModifySpec	string	任意	移行中にインスタンスの仕様を変更するかどうかを指定します。有効値： true：仕様を変更します。このパラメーターを true に設定した場合は、DBInstanceClass と DBInstanceStorage パラメーターの少なくとも一方を指定する必要があります。 false：仕様を変更しません。これはデフォルト値です。説明このパラメーターは RDS for MySQL インスタンスにのみ適用されます。	true
DBInstanceClass	string	任意	新しいインスタンスタイプ。インスタンスタイプは変更できますが、ストレージタイプは変更できません。 IsModifySpec パラメーターを true に設定した場合は、このパラメーターまたは DBInstanceStorage を指定する必要があります。インスタンスタイプの詳細については、「プライマリ ApsaraDB RDS for MySQL インスタンスタイプ」をご参照ください。	mysql.x4.xlarge.2
DBInstanceStorage	integer	任意	インスタンスの新しいストレージ容量。IsModifySpec パラメーターを true に設定した場合は、このパラメーターまたは DBInstanceClass を指定する必要があります。単位：GB。このパラメーターの値の範囲は、インスタンスタイプによって異なります。詳細については、「プライマリ ApsaraDB RDS for MySQL インスタンスタイプ」をご参照ください。	500
IoAccelerationEnabled	string	任意	ESSD のバッファプール拡張 (BPE) 機能を有効にするかどうかを指定します。有効値： 1：BPE を有効にします。 0：BPE を無効にします。説明 BPE の詳細については、「BPE の有効化」をご参照ください。	0
DBInstanceStorageType	string	任意	インスタンスのストレージタイプ。有効値： cloud_essd：パフォーマンスレベル 1 (PL1) の高性能 SSD (ESSD)。 cloud_essd2：PL2 の ESSD。 cloud_essd3：PL3 の ESSD。 cloud_ssd：標準 SSD。	cloud_essd
CustomExtraInfo	string	任意

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
DBInstanceId	string	インスタンス ID。	rm-uf6wjk5****
OrderId	integer	注文 ID。このパラメーターは RDS for MySQL インスタンスの場合にのみ返されます。	21334157599****
RequestId	string	リクエスト ID。	65BDA532-28AF-4122-AA39-B382721EEE64

例

成功レスポンス

JSONJSON

{
  "DBInstanceId": "rm-uf6wjk5****",
  "OrderId": 0,
  "RequestId": "65BDA532-28AF-4122-AA39-B382721EEE64"
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
400	RenewChange.Exist	The Current InstanceId existed renewChange order in RDS.
400	InvalidInstanceCommodityCode.NotFound	Parse commodityCode from lx and instance fail.
400	InvalidMigrateModifyClassOrStorage	Specified parameter DBInstanceClass or Storage is invalid.
400	EngineNotSupported	Engine specified cannot be supported the operation.
400	IncorrectDBInstanceLockMode.ValueNotSupported	The Current DB instance lock mode does not support this operation.
400	InvalidZoneId.NotNull	The parameter ZoneId must not be null or auto
400	InvalidZoneId.NotEqual	The parameter ZoneId is the same as the previous one
400	InvalidDispenseMode.Format	The specified dispense mode is not valid.
400	IncorrectDBInstanceType	Current DB instance type does not support this operation.
400	ZoneId.NotMatchWithCategory	The Number of ZoneId specified does not match with category
400	InvalidDefaultVSwitch.NotFound	The specified default virtual switch is not found in specified VPC.
400	InsufficientResourceCapacityCheck	There is insufficient capacity available for the requested instance with precheck.
400	UnsupportedReadOrBakReadState	Current DB instance has read or bak read instance running in unsupported states
400	IncorrectDBInstanceState	Current DB instance state does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.
400	SSLInstanceNotSupportThisOperation	The instance opened SSL, upgrade is not this operation
400	BYOLInstanceNotSupportThisOperation	The BYOL instance is not supported this operation
400	BYOKInstanceNotSupportThisOperation	The BYOK instance is not supported this operation
400	ADInstanceNotSupportThisOperation	The AD instance is not supported this operation
400	TDEInstanceNotSupportThisOperation	The instance opened TDE, this operation is not supported
400	InstanceIsSnapshotBackupNotSupportThisOperation	The instance backup method is snapshot backup, this operation is not supported
400	InstanceHasReadOnlyInstanceNotSupportThisOperation	The instance has read-only instance or is read-only instance, this operation is not supported
400	VswitchIpExhausted	No available ip in the specified vswitch.
400	OperationDenied.MasterDBInstanceState	The operation is not permitted due to status of master instance.
400	InvalidShareInstance.NotSupport	The share dbInstance is not support.
400	InvalidZoneIdSlave1.Missing	The parameter ZoneIdSlave1 must be specified.
400	MigrateAlreadyExistsFault	The rds instance already has a given vpc migrate task.
400	InvalidInstanceKind.NotSupport	The instance kind does not support this operation.
400	MissingCategory	The instance is missing a category parameter.
400	InvalidInstanceNodeType.NotFound	The specified NodeType is not found.
400	EngineVersionNotSupported	EngineVersion specified cannot be replicate with the source DB Instance.
400	CommodityCodeNotFound	CommodityCodeNotFound
400	InvalidTunnelId	Specified conn tunnel is not valid.
400	SSLNotSupport	The CharacterType of instance does not support SSL.
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.
400	Price.CommoditySys	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.
400	pay.noCreditCard	Account not bound to credit card.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.
400	KmsApiError	User secret key invalid.
400	System.SaleValidateFailed	Sales expression validation system error.
400	Abs.InvalidAccount.NotFound	account is not found.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.
400	RequiredParam.NotFound	Required input param is not found.
400	Parameters.Invalid	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.
400	Pay.NoCreditCard	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.
400	UnsupportedClassCode	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.
400	UnSupportDbTypeReduceDiskSize	The current instance does not support scale-in.
400	UnsupportedReduceDiskSize	Current Instance not support reduce disk size less than limit size.
400	UnsupportExtendDisk.NotSupport	Specified DB instance is unsupport extend disk.
400	ClassicNetDisabled	The classic network address is currently disabled, and the instance cannot perform configuration changes.
400	InvalidParamForXfs	Xfs instance must be single tenant standard instance.
400	InstanceHasLinkedServerInfo	The instance has linked server info, please delete linked server info first.
500	ExternalFailure	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.
403	OperationDenied.OutofUsage	The resource is out of usage.	ゾーンにリソースがありません。後でもう一度試してください。
403	IncorrectEffectiveTime	The specified EffectiveTime params is not valid.
403	InvalidTempInstance.NotSupport	The temp db Instance is not support.
403	OperationDenied.LockMode	The operation is not permitted due to instance being locked.	インスタンスがロックされましたため、操作が完了できませんでした。
403	ClassicNetworkType.NotSupport	The Classic instance network create is not support.
403	InstanceNetworkTypeNotFoundFault	The specified DBInstanceNetworkType is not found.
403	ProprietaryCloud.NotSupported	The proprietary cloud not supported.
403	MigrateAlreadyReadWriteSplitExistsFault	The rds instance already has a given vpc migrate task.
403	InvalidRegionAvzNotFound	Specified user does not find the region and avz.
403	ZoneIdNotSupported	The zone ID is not supported.
403	InvalidVpcInfo.NotFound	Specified VPC info does not exist.
403	InvalidMultiparamZoneInfoList	Zoneinfo list is invaild.
403	MigrateSlaveNotSupport	Current DB instance state does not support migrating slave, please switch the Primary/Secondary Instance first.
403	CloudDiskEncryptionNotSupport	The encryption key is not allowed for general-purpose instance.
403	IncorrectMinorVersion	Current engine minor version does not support operations.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.
403	InvalidUserOperatorPermission	The user permission does not support this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	OperationDenied.ZoneResource	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.
403	InstanceEngineType.NotSupport	The instance engine and type does not support operations.
403	UnsupportedByBlueGreenDeployment	Operation prohibited due to blue green deployment.
403	CurrentRecoveryModelNotSupportThisAction	Current recovery model not supported this action.
403	UnSupportNonXfsDiskSizeTooLarge	Non xfs disk types do not support upgrading to 60T or above.
403	ShrinkCountReachedLimit	Current DB shrink count reached the limit.
403	IncorrectReadDBInstanceDisksize	Read instance disk size must be equal or higher than primary instance.
404	InvalidDBInstanceName.NotFound	The database instance does not exist.
404	IncorrectVswitchId	The specified parameter VSwitchId is not valid.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.
404	Request.NotFound	The requested resource is not available.
404	HostInfo.NotFound	The specified host info is not found.

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

変更履歴

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

ApsaraDB RDS:MigrateToOtherZone