All Products
Search

This Product

    ApsaraDB RDS:MigrateToOtherZone

    Document Center

    ApsaraDB RDS:MigrateToOtherZone

    Last Updated:Nov 22, 2024

    Migrates an instance across zones in the same region.

    Operation description

    Supported database engines

    • RDS MySQL
    • RDS PostgreSQL
    • RDS SQL Server

    References

    Note : Before you call this operation, carefully read the following documentation. Make sure that you fully understand the prerequisites and impacts for calling this operation.

    Debugging

    You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

    Authorization information

    The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

    • Operation: the value that you can use in the Action element to specify the operation on a resource.
    • Access level: the access level of each operation. The levels are read, write, and list.
    • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
      • The required resource types are displayed in bold characters.
      • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
    • Condition Key: the condition key that is defined by the cloud service.
    • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
    OperationAccess levelResource typeCondition keyAssociated operation
    rds:MigrateToOtherZoneupdate
    *DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBInstanceIdstringYes

    The instance ID. You can call the DescribeDBInstances operation to query the instance ID.

    		rm-uf6wjk5xxxxxxxxxx
    VPCIdstringNo

    The ID of the virtual private cloud (VPC). Do not change the VPC of the instance when you migrate the instance across zones.

    • This parameter must be specified when the instance resides in a VPC.
    • If the instance runs SQL Server, you can change the VPC of the instance.
    		vpc-xxxxxxx
    ZoneIdstringYes

    The ID of the destination zone. You can call the DescribeRegions operation to query the most recent region list.

    		cn-hangzhou-b
    EffectiveTimestringNo

    The time when you want the change to take effect. Valid values:

    • Immediately (default): The change immediately takes effect.
    • MaintainTime: The change takes effect during the maintenance window. For more information, see ModifyDBInstanceMaintainTime.
    • ScheduleTime: The change takes effect at the point in time that you specify.
    Note If you set this parameter to ScheduleTime, you must specify the SwitchTime parameter.
    		Immediate
    VSwitchIdstringNo

    The vSwitch ID.

    • This parameter must be specified when the instance resides in a VPC. You can call the DescribeVSwitches operation to query existing vSwitches.
    • If the instance runs PostgreSQL or SQL Server and a secondary zone is specified for the instance, you can specify multiple vSwitch IDs, each of which corresponds to a zone. Separate the vSwitch IDs with commas (,).
    		vsw-uf6adz52c2pxxxxxxx
    CategorystringNo

    The RDS edition of the instance. Valid values:

    • Basic: RDS Basic Edition
    • HighAvailability: RDS High-availability Edition
    • AlwaysOn: SQL Server on RDS Cluster Edition
    • cluster: MySQL on RDS Cluster Edition
    • Finance: RDS Enterprise Edition
    		HighAvailability
    ZoneIdSlave1stringNo

    The secondary zone 1 of the instance.

    Note This parameter must be configured if the instance runs RDS editions other than RDS Basic Edition.
    		cn-hangzhou-c
    ZoneIdSlave2stringNo

    The secondary zone 2 of the instance.

    Note You can specify this parameter only for instances that run RDS Enterprise Edition.
    		cn-hangzhou-d
    SwitchTimestringNo

    The migration time. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

    Note This parameter is used with EffectiveTime. You must specify this parameter only when EffectiveTime is set to ScheduleTime.
    		2021-12-14T15:15:15Z
    IsModifySpecstringNo

    Specifies whether to change the specifications of the instance during the cross-zone migration. Valid values:

    • true: You want to change the specifications of the instance during the cross-zone migration. If you set this parameter to true, you must specify at least one of DBInstanceClass and DBInstanceStorage.
    • false (default): You do not want to change the specifications of the instance during the cross-zone migration.
    Note This parameter applies only to instances that run MySQL.
    		true
    DBInstanceClassstringNo

    The new instance type of the instance. You can change the instance type of the instance. You cannot change the storage type of the instance. If you set IsModifySpec to true, you must specify at least one of DBInstanceClass and DBInstanceStorage.

    For more information about instance types, see Primary ApsaraDB RDS for MySQL instance types.

    		mysql.x4.xlarge.2
    DBInstanceStoragelongNo

    The new storage capacity of the instance. If you set IsModifySpec to true, you must specify at least one of DBInstanceStorage and DBInstanceClass.

    Unit: GB. The available storage capacity range varies based on the instance type of the instance. For more information, see Primary ApsaraDB RDS for MySQL instance types.

    		500
    IoAccelerationEnabledstringNo

    A reserved parameter.

    		0

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The ID of the request.

    		65BDA532-28AF-4122-AA39-B382721EEE64
    DBInstanceIdstring

    The instance ID.

    		rm-uf6wjk5xxxxxxxxxx
    OrderIdlong

    The ID of the order. This parameter is returned only when the instance runs MySQL.

    		213341575990728

    Examples

    Sample success responses

    JSONformat

    {
  "RequestId": "65BDA532-28AF-4122-AA39-B382721EEE64",
  "DBInstanceId": "rm-uf6wjk5xxxxxxxxxx",
  "OrderId": 213341575990728
}

    Error codes

    HTTP status codeError codeError messageDescription
    400RenewChange.ExistThe Current InstanceId existed renewChange order in RDS.A specification change task is in progress. Try again after the task is completed.
    400InvalidInstanceCommodityCode.NotFoundParse commodityCode from lx and instance fail.-
    400InvalidMigrateModifyClassOrStorageSpecified parameter DBInstanceClass or Storage is invalid.-
    400EngineNotSupportedEngine specified cannot be supported the operation.The operation failed. This operation is not supported for the database engine version of the RDS instance. Update the minor engine version of the RDS instance.
    400IncorrectDBInstanceLockMode.ValueNotSupportedThe Current DB instance lock mode does not support this operation.The operation failed. The RDS instance is locked.
    400InvalidZoneId.NotNullThe parameter ZoneId must not be null or autoZoneId must not be null or auto.
    400InvalidZoneId.NotEqualThe parameter ZoneId is the same as the previous oneThe two zones are the same.
    400InvalidDispenseMode.FormatThe specified dispense mode is not valid.-
    400IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.The operation failed. The RDS instance is not in a ready state.
    400ZoneId.NotMatchWithCategoryThe Number of ZoneId specified does not match with category-
    400InvalidDefaultVSwitch.NotFoundThe specified default virtual switch is not found in specified VPC.-
    400InsufficientResourceCapacityCheckThere is insufficient capacity available for the requested instance with precheck.The available capacity of the instance to be prechecked is insufficient.
    400UnsupportedReadOrBakReadStateCurrent DB instance has read or bak read instance running in unsupported states-
    400IncorrectDBInstanceStateCurrent DB instance state does not support this operation.-
    400MirrorInsExistsSpecified DB instance mirror ins already existed.Specified DB instance mirror ins already existed.
    400SSLInstanceNotSupportThisOperationThe instance opened SSL, upgrade is not this operationThis operation is not supported for instances that have SSL enabled.
    400BYOLInstanceNotSupportThisOperationThe BYOL instance is not supported this operationThis operation is not supported for instances that are created from BYOL images.
    400BYOKInstanceNotSupportThisOperationThe BYOK instance is not supported this operationThis operation is not supported for instances that have disk encryption enabled.
    400ADInstanceNotSupportThisOperationThe AD instance is not supported this operationThis operation is not supported for instances that have been joined to an AD domain.
    400TDEInstanceNotSupportThisOperationThe instance opened TDE, this operation is not supportedThis operation is not supported for instances that have TDE enabled.
    400InstanceIsSnapshotBackupNotSupportThisOperationThe instance backup method is snapshot backup, this operation is not supportedThis operation is not supported for instances that have snapshot backup enabled.
    400InstanceHasReadOnlyInstanceNotSupportThisOperationThe instance has read-only instance or is read-only instance, this operation is not supportedThis operation is not supported because this instance has read-only instances or it is a read-only instance.
    400VswitchIpExhaustedNo available ip in the specified vswitch.No available IP address exists in the specified vSwitch.
    400OperationDenied.MasterDBInstanceStateThe operation is not permitted due to status of master instance.The operation failed. The configuration of the read-only instance is being changed. In this case, you cannot perform this operation on the primary instance. Wait until the configuration of the read-only instance is changed and try again.
    400InvalidShareInstance.NotSupportThe share dbInstance is not support.This operation is not supported for shared instances.
    400InvalidZoneIdSlave1.MissingThe parameter ZoneIdSlave1 must be specified.You must specify the secondary zone ID.
    400MigrateAlreadyExistsFaultThe rds instance already has a given vpc migrate task.The RDS instance already contains a VPC migration task.
    400InvalidInstanceKind.NotSupportThe instance kind does not support this operation.The instance type does not support this operation.
    400MissingCategoryThe instance is missing a category parameter.-
    400InvalidInstanceNodeType.NotFoundThe specified NodeType is not found.-
    400EngineVersionNotSupportedEngineVersion specified cannot be replicate with the source DB Instance.Instance cloning is not supported for the database engine version of the current instance.
    400CommodityCodeNotFoundCommodityCodeNotFoundThe specified parameter CommodityCode is invalid. Please check again.
    400InvalidTunnelIdSpecified conn tunnel is not valid.-
    400SSLNotSupportThe CharacterType of instance does not support SSL.The character type of the instance does not support SSL.
    400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.A package instance is not allowed to operate independently.
    400Price.PricingPlanResultNotFoundPricing plan price result not found.Pricing plan price result not found.
    400Order.NoRealNameAuthenticationYou 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.You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.
    400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.Your account available limit is less than 0, please recharge before trying to purchase.
    400CommodityServiceCalling.ExceptionFailed to call commodity service.Failed to call commodity service return.
    400RegionDissolvedEOMDear 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.Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.
    400Commodity.InvalidComponentThe module you purchased is not legal, please buy it again.The module you purchased is not legal, please buy it again.
    400RegionEndTimeDissolvedIndiaCloud services in the India (Mumbai) region will be discontinued. Set the validity date to July 15, 2024 or earlier than July 15, 2024.Hello customer, this area has been abolished.
    400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.Hello customer, this area has been abolished.
    400Price.CommoditySysCommodity system call exception.Commodity system call exception.
    400Pay.InsufficientBalanceInsufficient available balance.Insufficient available balance.
    400Order.PeriodInvalidThere is a problem with the period you selected, please choose again.There is a problem with the period you selected, please choose again.
    400pay.noCreditCardAccount not bound to credit card.-
    400Order.InstHasUnpaidOrderThere is an unpaid order for the service you have purchased. Please pay or void it before placing the order.There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
    400noAvailablePaymentMethodNo payment method is specified for your account. We recommend that you add a payment method.-
    400BasicInfoUncompletedYour information is incomplete. Complete your information before the operation.Your basic information is not complete, please complete your basic information before operation.
    400Risk.RiskControlRejectionYour account is abnormal, please contact customer service for details.Your account is abnormal, please contact customer service for details.
    400BasicInfoUncompletedYour information is incomplete, Complete your information before the operation.-
    400Api.NotSupportSpecified api is not supported.The current interface does not support.
    400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
    400InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in records.The DBInstanceId provided does not exist.
    400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk typeThe current instance type does not support the specified storage type.
    400InvalidParamSepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.
    400KmsApiErrorUser secret key invalid.The user key is invalid.
    400System.SaleValidateFailedSales expression validation system error.A system error occurs when the sales expression is verified.
    400Abs.InvalidAccount.NotFoundaccount is not found.The account does not exist.
    400SqlExecuteFailedOrTimeoutsql command execution failed or timed out:%s.SQL command execution failed or timed out
    400ColdData.EngineVersionNotSupportThe current instance engine version not support coldDataEnabled.The current instance engine version not support coldDataEnabled.
    400ColdData.MinorVersionNotSupportThe current instance minor version not support coldDataEnabled.The current instance minor version not support coldDataEnabled.
    400IncorrectTargetClasscodeThe current instance type does not support this operation.This operation is not supported by the instance type.
    400InvalidConnectionString.DuplicateSpecified connection string already exists in the RDS.The link address name is duplicate. Please reset the connection string.
    400RequiredParam.NotFoundRequired input param is not found.-
    400Parameters.InvalidParameter error, please check the parameters.Parameter error, please check the parameters.
    400BackupPolicyNotSupportCold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
    400InvalidReleasedKeepPolicy.FormatSpecified Released Keep Policy is not valid.Specified Released Keep Policy is not valid.
    400InvalidDBInstanceEngineType.Formatthe DB instance engine type does not support this operation.This operation is not supported for the database engine of the instance.
    400Pay.NoCreditCardNo credit cards.No credit cards.
    400VpcNetworkTypeNotSupportThe vpc network type instance does not support this operation.The vpc network type instance does not support this operation.
    400UnsupportedClassCodeThe specified DB instance class stops selling.The specified DB instance class stops selling.
    400InvalidBackupSetThe specified database does not exist in the backup set.The specified database does not exist in the backup set.
    400OrdTCommodityQueryErrorFailed to query for product.Failed to query product.
    403OperationDenied.OutofUsageThe resource is out of usage.The available resources in the zone are insufficient. Specify a different zone.
    403IncorrectEffectiveTimeThe specified EffectiveTime params is not valid.The value of the EffectiveTime parameter is invalid.
    403InvalidTempInstance.NotSupportThe temp db Instance is not support.The instance is locked.
    403OperationDenied.LockModeThe operation is not permitted due to instance being locked.The operation failed. The RDS instance is locked. Check whether the RDS instance has expired or its storage capacity is exhausted. If the RDS instance has expired, renew the RDS instance. If the storage capacity is exhausted, expand the storage capacity of the RDS instance.
    403ClassicNetworkType.NotSupportThe Classic instance network create is not support.The current instance cannot be deployed in the classic network. Change the network type to VPC.
    403InstanceNetworkTypeNotFoundFaultThe specified DBInstanceNetworkType is not found.The network type failed the verification check. The network type cannot be found.
    403ProprietaryCloud.NotSupportedThe proprietary cloud not supported.-
    403MigrateAlreadyReadWriteSplitExistsFaultThe rds instance already has a given vpc migrate task.A task of migrating data to the specified VPC already exists.
    403InvalidRegionAvzNotFoundSpecified user does not find the region and avz.-
    403ZoneIdNotSupportedThe zone ID is not supported.The operation failed. The operation is not supported in the region.
    403InvalidVpcInfo.NotFoundSpecified VPC info does not exist.The specified VPC does not exist.
    403InvalidMultiparamZoneInfoListZoneinfo list is invaild.-
    403MigrateSlaveNotSupportCurrent DB instance state does not support migrating slave, please switch the Primary/Secondary Instance first.The status of the current instance does not support the migration of only the backup database. Forced migration will reduce the performance of accessing the database. Please perform an HA switch first.
    403CloudDiskEncryptionNotSupportThe encryption key is not allowed for general-purpose instance.Universal instances do not support cloud disk encryption.
    403IncorrectMinorVersionCurrent engine minor version does not support operations.This operation is not supported for the current minor engine version.
    403OrderStatus.UnPaidThe specified db instance has unpaid order.The instance has an unpaid order. Please pay first and try again.
    403InvalidReduceDiskSizeThe storage capacity after the scale-down must be larger than the used amount.The scale-in target capacity cannot be less than the current storage space usage
    403CloudSSDNotSupportCloud ssd does not support this operation, please upgrade to essd.-
    403InvalidUserOperatorPermissionThe user permission does not support this operation.The user is not authorized to perform this operation.
    403InvalidVswitchIdSpecified conn vswitch id is not valid.-
    403OperationDenied.ZoneResourceThere is no available zone for inventory.There is no available zone for inventory.
    403NotInFlowControllerSorry,no permission.Sorry,no permission.
    403InvalidKmsKeyKms key is disabled.-
    403InvalidInstanceLevel.MalformedCurrent DB instance level does not support this operation.The specified database instance type does not support this operation.
    404InvalidDBInstanceName.NotFoundThe database instance does not exist.The name of the RDS instance cannot be found. Check the name of the RDS instance.
    404IncorrectVswitchIdThe specified parameter VSwitchId is not valid.The vSwitch ID is invalid.
    404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.The instance does not have permissions to access Key Management Service (KMS).
    404Request.NotFoundThe requested resource is not available.The requested resources are unavailable.
    404HostInfo.NotFoundThe specified host info is not found.-
    500ExternalFailureThe request processing has failed due to external service failure.The request processing has failed due to external service failure.
    500RequestMetaDataFailedThe service request failed. Please try again later or contact service personnel.The service request failed. Please try again later or contact service personnel.
    500InvokeProxyFailureThe request processing has failed due to service failure of rds api.The request failed to be processed due to an RDS API failure.

    For a list of error codes, visit the Service error codes.

    Change history

    Change timeSummary of changesOperation
    2024-10-31The Error code has changedView Change Details
    2024-08-15The Error code has changedView Change Details
    2024-08-15The Error code has changedView Change Details
    2024-06-03The Error code has changedView Change Details
    2024-04-17The Error code has changedView Change Details
    2024-01-04The Error code has changed. The request parameters of the API has changedView Change Details
    2023-03-31The Error code has changedView Change Details
    2023-03-01The Error code has changedView Change Details
    2022-10-28The Error code has changedView Change Details
    2022-10-13The Error code has changedView Change Details
    2022-06-23The Error code has changedView Change Details
    2022-06-08The Error code has changedView Change Details
    2022-01-12The Error code has changed. The request parameters of the API has changed. The response structure of the API has changedView Change Details
    2021-10-26The Error code has changed. The request parameters of the API has changedView Change Details