Todos os produtos
Search

Este produto

    ApsaraDB RDS:MigrateToOtherZone

    Central de documentação

    ApsaraDB RDS:MigrateToOtherZone

    Última atualização: Jul 07, 2026

    Use esta API para mover uma instância RDS para uma zona de disponibilidade diferente.

    Descrição da operação

    Mecanismos compatíveis

    • RDS MySQL

    • RDS PostgreSQL

    • RDS SQL Server.

    Documentação relacionada

    Importante

    Antes de chamar esta API, leia a documentação relevante. Certifique-se de compreender os pré-requisitos e o impacto desta operação.

    Experimente agora

    Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

    Testar

    Autorização RAM

    A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

    • Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.

    • API: A API que você pode chamar para executar a ação.

    • Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.

    • Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.

      • Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.

      • Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.

    • Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.

    • Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

    Ação

    Nível de acesso

    Tipo de recurso

    Chave de condição

    Ação dependente

    rds:MigrateToOtherZone

    update

    *DBInstance

    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
    • rds:ResourceTag
    		 Nenhuma

    Parâmetros da solicitação

    Parâmetro

    Tipo

    Obrigatório

    Descrição

    Exemplo
    DBInstanceId

    string

    Sim

    O ID da instância. Você pode chamar a operação DescribeDBInstances para consultar os IDs das instâncias.

    rm-uf6wjk5****
    VPCId

    string

    Não

    O ID da nuvem privada virtual (VPC). A VPC da instância não pode ser alterada quando a instância é migrada para outra zona de disponibilidade.

    • Este parâmetro é obrigatório se a instância residir em uma VPC.

    • Se a instância executar o SQL Server, você poderá alterar a VPC durante a migração.

    vpc-****
    ZoneId

    string

    Sim

    O ID da zona de disponibilidade de destino. Você pode chamar a operação DescribeRegions para consultar os IDs das zonas de disponibilidade.

    cn-hangzhou-b
    EffectiveTime

    string

    Não

    O horário em que a migração entra em vigor. Valores válidos:

    • Immediate: A migração entra em vigor imediatamente. Este é o valor padrão.

    • MaintainTime: A migração entra em vigor durante a janela de manutenção. Para obter mais informações, consulte ModifyDBInstanceMaintainTime.

    • ScheduleTime: A migração entra em vigor em um horário especificado.

    Nota

    Se você definir este parâmetro como ScheduleTime, também deverá especificar o parâmetro SwitchTime.

    Immediate
    VSwitchId

    string

    Não

    O ID do vSwitch.

    • Este parâmetro é obrigatório se a instância residir em uma VPC. Você pode chamar a operação DescribeVSwitches para consultar os vSwitches disponíveis.

    • Para uma instância RDS que executa PostgreSQL ou SQL Server, você pode especificar vários IDs de vSwitch para uma migração multizona. Separe os IDs com vírgulas (,) e certifique-se de que os IDs de vSwitch correspondam às zonas de disponibilidade.

    vsw-uf6adz52c2p****
    Category

    string

    Não

    A edição da instância. Valores válidos:

    • Basic: Basic Edition

    • HighAvailability: High-availability Edition

    • AlwaysOn: Cluster Edition para SQL Server

    • cluster: Cluster Edition para MySQL

    • Finance: Enterprise Edition (com três nós).

    HighAvailability
    ZoneIdSlave1

    string

    Não

    O ID da primeira zona de disponibilidade secundária.

    Nota

    Este parâmetro é obrigatório para instâncias de todas as edições, exceto a Basic Edition.

    cn-hangzhou-c
    ZoneIdSlave2

    string

    Não

    O ID da segunda zona de disponibilidade secundária.

    Nota

    Este parâmetro é aplicável apenas a instâncias que executam a Enterprise Edition (com três nós).

    cn-hangzhou-d
    SwitchTime

    string

    Não

    O horário agendado para alternar a instância para a nova zona de disponibilidade. Especifique o horário no formato aaaa-MM-ddTHH:mm:ssZ. O horário deve estar em UTC.

    Nota

    Este parâmetro é obrigatório apenas quando você define o parâmetro EffectiveTime como ScheduleTime.

    2021-12-14T15:15:15Z
    IsModifySpec

    string

    Não

    Especifica se as especificações da instância devem ser modificadas durante a migração. Valores válidos:

    • true: Modifica as especificações. Se você definir este parâmetro como true, deverá especificar pelo menos um dos parâmetros DBInstanceClass e DBInstanceStorage.

    • false: Não modifica as especificações. Este é o valor padrão.

    Nota

    Este parâmetro se aplica apenas a instâncias do RDS for MySQL.

    true
    DBInstanceClass

    string

    Não

    O novo tipo de instância. Você pode alterar o tipo de instância, mas não o tipo de armazenamento. Se você definir o parâmetro IsModifySpec como true, deverá especificar este parâmetro ou DBInstanceStorage.

    Para obter mais informações sobre os tipos de instância, consulte Tipos de instância primária do ApsaraDB RDS for MySQL.

    mysql.x4.xlarge.2
    DBInstanceStorage

    integer

    Não

    A nova capacidade de armazenamento da instância. Se você definir o parâmetro IsModifySpec como true, deverá especificar este parâmetro ou DBInstanceClass.

    Unidade: GB. O intervalo de valores deste parâmetro varia de acordo com o tipo de instância. Para obter mais informações, consulte Tipos de instância primária do ApsaraDB RDS for MySQL.

    500
    IoAccelerationEnabled

    string

    Não

    Especifica se o recurso Buffer Pool Extension (BPE) deve ser ativado para o ESSD. Valores válidos:

    • 1: ativa o BPE.

    • 0: desativa o BPE.

    Nota

    Para obter mais informações sobre o BPE, consulte Ativar BPE.

    0
    DBInstanceStorageType

    string

    Não

    O tipo de armazenamento da instância. Valores válidos:

    • cloud_essd: SSD aprimorado (ESSD) de nível de desempenho 1 (PL1).

    • cloud_essd2: ESSD de PL2.

    • cloud_essd3: ESSD de PL3.

    • cloud_ssd: SSD padrão.

    cloud_essd
    CustomExtraInfo

    string

    Não

    Elementos de resposta

    Elemento

    Tipo

    Descrição

    Exemplo

    object

    Os parâmetros de resposta.

    DBInstanceId

    string

    O ID da instância.

    rm-uf6wjk5****
    OrderId

    integer

    O ID do pedido. Este parâmetro é retornado apenas para instâncias do RDS for MySQL.

    21334157599****
    RequestId

    string

    O ID da solicitação.

    65BDA532-28AF-4122-AA39-B382721EEE64

    Exemplos

    Resposta de sucesso

    JSON formato

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

    Códigos de erro

    Código de status HTTP

    Código de erro

    Mensagem de erro

    Descrição
    400 RenewChange.Exist The Current InstanceId existed renewChange order in RDS. A specification change task is in progress. Try again after the task is completed.
    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. 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.
    400 IncorrectDBInstanceLockMode.ValueNotSupported The Current DB instance lock mode does not support this operation. The operation failed. The RDS instance is locked.
    400 InvalidZoneId.NotNull The parameter ZoneId must not be null or auto ZoneId must not be null or auto.
    400 InvalidZoneId.NotEqual The parameter ZoneId is the same as the previous one The two zones are the same.
    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. The available capacity of the instance to be prechecked is insufficient.
    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. Specified DB instance mirror ins already existed.
    400 SSLInstanceNotSupportThisOperation The instance opened SSL, upgrade is not this operation This operation is not supported for instances that have SSL enabled.
    400 BYOLInstanceNotSupportThisOperation The BYOL instance is not supported this operation This operation is not supported for instances that are created from BYOL images.
    400 BYOKInstanceNotSupportThisOperation The BYOK instance is not supported this operation This operation is not supported for instances that have disk encryption enabled.
    400 ADInstanceNotSupportThisOperation The AD instance is not supported this operation This operation is not supported for instances that have been joined to an AD domain.
    400 TDEInstanceNotSupportThisOperation The instance opened TDE, this operation is not supported This operation is not supported for instances that have TDE enabled.
    400 InstanceIsSnapshotBackupNotSupportThisOperation The instance backup method is snapshot backup, this operation is not supported This operation is not supported for instances that have snapshot backup enabled.
    400 InstanceHasReadOnlyInstanceNotSupportThisOperation The instance has read-only instance or is read-only instance, this operation is not supported This operation is not supported because this instance has read-only instances or it is a read-only instance.
    400 VswitchIpExhausted No available ip in the specified vswitch. No available IP address exists in the specified vSwitch.
    400 OperationDenied.MasterDBInstanceState The 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.
    400 InvalidShareInstance.NotSupport The share dbInstance is not support. This operation is not supported for shared instances.
    400 InvalidZoneIdSlave1.Missing The parameter ZoneIdSlave1 must be specified. You must specify the secondary zone ID.
    400 MigrateAlreadyExistsFault The rds instance already has a given vpc migrate task. The RDS instance already contains a VPC migration task.
    400 InvalidInstanceKind.NotSupport The instance kind does not support this operation. The instance type 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. Instance cloning is not supported for the database engine version of the current instance.
    400 CommodityCodeNotFound CommodityCodeNotFound The specified parameter CommodityCode is invalid. Please check again.
    400 InvalidTunnelId Specified conn tunnel is not valid.
    400 SSLNotSupport The CharacterType of instance does not support SSL. The character type of the instance does not support SSL.
    400 Order.ComboInstanceNotAllowOperate A package instance is not allowed to operate independently. A package instance is not allowed to operate independently.
    400 Price.PricingPlanResultNotFound Pricing plan price result not found. 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. 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.
    400 InsufficientAvailableQuota Your 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.
    400 CommodityServiceCalling.Exception Failed to call commodity service. Failed to call commodity service return.
    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. 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.
    400 Commodity.InvalidComponent The module you purchased is not legal, please buy it again. 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. Hello customer, this area has been abolished.
    400 Price.CommoditySys Commodity system call exception. Commodity system call exception.
    400 Pay.InsufficientBalance Insufficient available balance. Insufficient available balance.
    400 Order.PeriodInvalid There is a problem with the period you selected, please choose again. 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. 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. No payment method has been specified for your account. We recommend that you add a payment method.
    400 BasicInfoUncompleted Your information is incomplete. Complete your information before the operation. Your basic information is not complete, please complete your basic information before operation.
    400 Risk.RiskControlRejection Your account is abnormal, please contact customer service for details. Your account is abnormal, please contact customer service for details.
    400 Api.NotSupport Specified api is not supported. The current interface does not support.
    400 ContainForbiddenLabelError There 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.
    400 InvalidDBInstanceId.NotFound The DBInstanceId provided does not exist in records. The DBInstanceId provided does not exist.
    400 InvalidInstanceLevel.DiskType Specified instance level not support request disk type The current instance type does not support the specified storage type.
    400 InvalidParam Sepcified 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.
    400 KmsApiError User secret key invalid. The user key is invalid.
    400 System.SaleValidateFailed Sales expression validation system error. A system error occurs when the sales expression is verified.
    400 Abs.InvalidAccount.NotFound account is not found. The account does not exist.
    400 SqlExecuteFailedOrTimeout sql command execution failed or timed out:%s. SQL command execution failed or timed out
    400 ColdData.EngineVersionNotSupport The current instance engine version not support coldDataEnabled. The current instance engine version not support coldDataEnabled.
    400 ColdData.MinorVersionNotSupport The current instance minor version not support coldDataEnabled. The current instance minor version not support coldDataEnabled.
    400 IncorrectTargetClasscode The current instance type does not support this operation. This operation is not supported by the instance type.
    400 InvalidConnectionString.Duplicate Specified connection string already exists in the RDS. The link address name is duplicate. Please reset the connection string.
    400 RequiredParam.NotFound Required input param is not found.
    400 Parameters.Invalid Parameter error, please check the parameters. Parameter error, please check the parameters.
    400 BackupPolicyNotSupport Cold 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.
    400 InvalidReleasedKeepPolicy.Format Specified Released Keep Policy is not valid. Specified Released Keep Policy is not valid.
    400 InvalidDBInstanceEngineType.Format the DB instance engine type does not support this operation. This operation is not supported for the database engine of the instance.
    400 Pay.NoCreditCard No credit cards. No credit cards.
    400 VpcNetworkTypeNotSupport The vpc network type instance does not support this operation. The vpc network type instance does not support this operation.
    400 UnsupportedClassCode The specified DB instance class stops selling. The specified DB instance class stops selling.
    400 InvalidBackupSet The specified database does not exist in the backup set. The specified database does not exist in the backup set.
    400 OrdTCommodityQueryError Failed to query for product. Failed to query product.
    400 ProductInstanceReleased The instance has been released. Please check before placing the order. The instance has been released, please verify and place an order.
    400 RegionEndTimeDissolvedIndia The region is no longer supported. The region is no longer supported.
    400 UnSupportDbTypeReduceDiskSize The current instance does not support scale-in. The current instance does not support scale-in.
    400 UnsupportedReduceDiskSize Current Instance not support reduce disk size less than limit size. The current instance does not support reducing the disk size to less than the limit size.
    400 UnsupportExtendDisk.NotSupport Specified DB instance is unsupport extend disk. Disk expansion is not supported on the specified instance.
    400 ClassicNetDisabled The classic network address is currently disabled, and the instance cannot perform configuration changes. The classic network address is currently disabled and the instance cannot perform configuration changes.
    400 InvalidParamForXfs Xfs instance must be single tenant standard instance. Xfs instance must be single tenant standard instance.
    400 InstanceHasLinkedServerInfo The instance has linked server info, please delete linked server info first. The current instance has a linked server. Please delete it before migrating to the Availability Zone.
    500 ExternalFailure The request processing has failed due to external service failure. The request processing has failed due to external service failure.
    500 RequestMetaDataFailed The service request failed. Please try again later or contact service personnel. 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. The request failed to be processed due to an RDS API failure.
    403 OperationDenied.OutofUsage The resource is out of usage. The available resources in the zone are insufficient. Specify a different zone.
    403 IncorrectEffectiveTime The specified EffectiveTime params is not valid. The value of the EffectiveTime parameter is invalid.
    403 InvalidTempInstance.NotSupport The temp db Instance is not support. The instance is locked.
    403 OperationDenied.LockMode The 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.
    403 ClassicNetworkType.NotSupport The Classic instance network create is not support. The current instance cannot be deployed in the classic network. Change the network type to VPC.
    403 InstanceNetworkTypeNotFoundFault The specified DBInstanceNetworkType is not found. The network type failed the verification check. The network type cannot be found.
    403 ProprietaryCloud.NotSupported The proprietary cloud not supported.
    403 MigrateAlreadyReadWriteSplitExistsFault The rds instance already has a given vpc migrate task. A task of migrating data to the specified VPC already exists.
    403 InvalidRegionAvzNotFound Specified user does not find the region and avz.
    403 ZoneIdNotSupported The zone ID is not supported. The operation failed. The operation is not supported in the region.
    403 InvalidVpcInfo.NotFound Specified VPC info does not exist. The specified VPC 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. 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.
    403 CloudDiskEncryptionNotSupport The encryption key is not allowed for general-purpose instance. Universal instances do not support cloud disk encryption.
    403 IncorrectMinorVersion Current engine minor version does not support operations. This operation is not supported for the current minor engine version.
    403 OrderStatus.UnPaid The specified db instance has unpaid order. The instance has an unpaid order. Please pay first and try again.
    403 InvalidReduceDiskSize The 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
    403 CloudSSDNotSupport Cloud ssd does not support this operation, please upgrade to essd.
    403 InvalidUserOperatorPermission The user permission does not support this operation. The user is not authorized to perform this operation.
    403 InvalidVswitchId Specified conn vswitch id is not valid.
    403 OperationDenied.ZoneResource There is no available zone for inventory. There is no available zone for inventory.
    403 NotInFlowController Sorry,no permission. Sorry,no permission.
    403 InvalidKmsKey Kms key is disabled.
    403 InvalidInstanceLevel.Malformed Current DB instance level does not support this operation. The specified database instance type does not support this operation.
    403 InstanceEngineType.NotSupport The instance engine and type does not support operations. The RDS MySQL instance engine and type do not support this operation. Check whether the instance kindcode and kernel minor version are too low and upgrade the kernel minor version.
    403 UnsupportedByBlueGreenDeployment Operation prohibited due to blue green deployment. The operation is not allowed because a blue-green deployment exists.
    403 CurrentRecoveryModelNotSupportThisAction Current recovery model not supported this action. The current recovery model does not support.
    403 UnSupportNonXfsDiskSizeTooLarge Non xfs disk types do not support upgrading to 60T or above. Non-xfs disk types do not support upgrading to 60T or higher.
    403 ShrinkCountReachedLimit Current DB shrink count reached the limit.
    403 IncorrectReadDBInstanceDisksize Read instance disk size must be equal or higher than primary instance. The disk size of the read-only instance must be equal to or greater than that of the primary instance.
    404 InvalidDBInstanceName.NotFound The database instance does not exist. The name of the RDS instance cannot be found. Check the name of the RDS instance.
    404 IncorrectVswitchId The specified parameter VSwitchId is not valid. The vSwitch ID is invalid.
    404 InvalidClusterKms The current instance does not authorized to access the Key Management Service. The instance does not have permissions to access Key Management Service (KMS).
    404 Request.NotFound The requested resource is not available. The requested resources are unavailable.
    404 HostInfo.NotFound The specified host info is not found.

    Consulte Códigos de Erro para uma lista completa.

    Notas de versão

    Consulte Notas de Versão para uma lista completa.