All Products
Search

This Product

    ApsaraDB RDS:MigrateToOtherZone

    Document Center

    ApsaraDB RDS:MigrateToOtherZone

    Last Updated:Mar 21, 2023

    You can call the MigrateToOtherZone operation to migrate an instance across zones.

    Operation Description

    The prerequisites for this operation vary based on the database engine of the instance. For more information, see the following topics:

    NoteThis operation allows you to migrate an instance across zones in the same region. This operation does not allow you to migrate an instance across zones in different regions. For example, you cannot migrate an instance from a zone in the China (Hangzhou) region to a zone in the China (Qingdao) region.

    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 keyAssociation operation
    rds:MigrateToOtherZoneWRITE
    • RDS
      acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    		none

    Request parameters

    ParameterTypeRequiredDescriptionExample
    DBInstanceIdstringYes

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

    		rm-uf6wjk5xxxxxxxxxx
    VPCIdstringNo

    The ID of the virtual private cloud (VPC). Do not change the VPC of the instance.

    Note
  • If the instance resides in a VPC, you must specify this parameter.
  • 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 zone list.

    		cn-hangzhou-b
    EffectiveTimestringNo

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

    • Immediately: The change immediately takes effect. This is the default value.
    • 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.
    NoteIf you set this parameter to ScheduleTime, you must also specify the SwitchTime parameter.
    		Immediate
    VSwitchIdstringNo

    The ID of the vSwitch.

    Note
  • If the instance resides in a VPC, you must specify this parameter. You can call the DescribeVSwitches operation to query the ID of the vSwitch.
  • 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: RDS Cluster Edition
    • Finance: RDS Enterprise Edition
    		HighAvailability
    ZoneIdSlave1stringNo

    The zone of the secondary instance.

    NoteIf the instance does not run RDS Basic Edition, you must specify this parameter.
    		cn-hangzhou-c
    ZoneIdSlave2stringNo

    The zone of the logger instance.

    NoteIf the instance runs RDS Enterprise Edition, you must specify this parameter.
    		cn-hangzhou-d
    SwitchTimestringNo

    The point in time at which you want the change to take effect. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

    NoteThis parameter is used with the EffectiveTime parameter. You must specify this parameter only when the EffectiveTime parameter 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 the DBInstanceClass and DBInstanceStorage parameters.
    • false: You do not want to change the specifications of the instance during the cross-zone migration. This is the default value.
    NoteThis 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 the IsModifySpec parameter to true, you must specify at least one of the DBInstanceClass and DBInstanceStorage parameters.

    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 the IsModifySpec parameter to true, you must specify at least one of the DBInstanceStorage and DBInstanceClass parameters.

    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

    Response parameters

    ParameterTypeDescriptionExample
    object
    RequestIdstring

    The ID of the request.

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

    The ID of the instance.

    		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.-
    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.
    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.
    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.

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

    Change history

    Change timeSummary of changesOperation
    2022-10-28The error codes of the API operation change.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 400 change
      Error Codes 403 change
      Added Error Codes: 404
    2022-10-13The error codes of the API operation change.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 400 change
      delete Error Codes: 403
    2022-06-23The error codes of the API operation change.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 400 change
      delete Error Codes: 403
    2022-06-08The error codes of the API operation change.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 400 change
      delete Error Codes: 403
    2022-01-12The error codes of the API operation change.,The input parameters of the API operation change.,The response structure of the API operation changes.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      Error Codes 400 change
      delete Error Codes: 403
    Input ParametersThe input parameters of the API operation change.
      Added Input Parameters: IsModifySpec
      Added Input Parameters: DBInstanceClass
      Added Input Parameters: DBInstanceStorage
    Output ParametersThe response structure of the API operation changes.
    2021-10-26The error codes of the API operation change.,The input parameters of the API operation change.
    Change itemChange content
    Error CodesThe error codes of the API operation change.
      delete Error Codes: 400
      delete Error Codes: 403
    Input ParametersThe input parameters of the API operation change.
      Added Input Parameters: SwitchTime