AI 助理
备案控制台
文档
产品文档
输入文档关键字查找
首页 云数据库 RDS RDS SQL Server数据库 开发参考 RDS SQL Server API参考 API目录 实例 MigrateToOtherZone - 迁移RDS实例可用区

MigrateToOtherZone - 迁移RDS实例可用区

更新时间：
一键部署
产品详情
相关技术圈
我的收藏

该接口用于迁移RDS实例的可用区。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server

相关功能文档

注意 使用该接口前，请仔细阅读功能文档，确保完全了解使用接口的前提条件及使用后造成的影响后，再进行操作。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
rds:MigrateToOtherZoneWRITE
  • DBInstance
    acs:rds:{#regionId}:{#accountId}:dbinstance/{#dbinstanceId}
  • rds:ResourceTag
无

请求参数

名称类型必填描述示例值
DBInstanceIdstring是

实例 ID。可调用 DescribeDBInstances 获取。

rm-uf6wjk5****
VPCIdstring否

专有网络 VPC ID。迁移可用区时 VPC 不能变更，需保持不变。

  • 专有网络实例迁移可用区时必须传入该参数。
  • 如果实例引擎为 SQL Server，迁移可用区 VPC 可支持变更。
vpc-****
ZoneIdstring是

目标可用区 ID，可调用 DescribeRegions 获取。

cn-hangzhou-b
EffectiveTimestring否

生效时间，取值：

  • Immediate：默认值，立即生效。
  • MaintainTime：在可运维时间段内生效，请参见 ModifyDBInstanceMaintainTime。
  • ScheduleTime：手动指定生效时间。
说明 如果在本参数中传入 ScheduleTime，则还需要传入 SwitchTime 参数。
Immediate
VSwitchIdstring否

交换机 ID。

  • 专有网络实例迁移可用区时必须传入该参数。可通过调用 DescribeVSwitches 接口查询已创建的交换机。
  • 当 RDS PostgreSQL、SQL Server 实例迁移可用区配置了备可用区时，此参数可以配置多个，用英文逗号（,）分隔，与可用区对应。
vsw-uf6adz52c2p****
Categorystring否

实例系列，取值：

  • Basic：基础系列
  • HighAvailability：高可用系列
  • AlwaysOn：SQL Server 集群系列
  • cluster：MySQL 集群系列
  • Finance：三节点企业系列
HighAvailability
ZoneIdSlave1string否

备可用区 1。

说明 非基础系列实例需要传入该参数。
cn-hangzhou-c
ZoneIdSlave2string否

备可用区 2。

说明 仅三节点企业系列实例可传入该参数。
cn-hangzhou-d
SwitchTimestring否

切换可用区的自定义生效时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

说明 本参数配合 EffectiveTime 参数使用，仅在 EffectiveTime 为 ScheduleTime 时需要传入。
2021-12-14T15:15:15Z
IsModifySpecstring否

是否在迁移可用区时变配。

  • true：变配，当配置为 true 时，至少需要配置 DBInstanceClass 或 DBInstanceStorage 中的一个参数。
  • false：默认值，不变配。
说明 该参数仅 RDS MySQL 实例适用。
true
DBInstanceClassstring否

目标实例规格代码，只支持变更规格，不支持变更存储类型。 当 IsModifySpec 参数配置为 true 时，至少需要配置本参数和 DBInstanceStorage 中的一个。

实例规格代码请参见RDS MySQL 主实例规格列表。

mysql.x4.xlarge.2
DBInstanceStoragelong否

目标存储空间大小。当 IsModifySpec 参数配置为 true 时，至少需要配置本参数和 DBInstanceClass 中的一个。

单位：GB。 取值范围：不同规格可扩容存储空间大小不同，具体请以RDS MySQL 主实例规格列表为准。

500
IoAccelerationEnabledstring否

是否开启通用云盘 IO 加速功能，参数取值含义如下：

  • 1：开启
  • 0：不开启
说明 通用云盘的 IO 加速功能的更多信息，请参见通用云盘 IO 加速功能技术介绍。
0

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求 ID。

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

实例 ID。

rm-uf6wjk5****
OrderIdlong

订单 ID，仅 MySQL 实例适用。

21334157599****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400RenewChange.ExistThe Current InstanceId existed renewChange order in RDS.当前存在变配任务未完成，请等待完成后重试。
400InvalidInstanceCommodityCode.NotFoundParse commodityCode from lx and instance fail.-
400InvalidMigrateModifyClassOrStorageSpecified parameter DBInstanceClass or Storage is invalid.指定的参数DBInstanceClass或Storage无效.
400EngineNotSupportedEngine specified cannot be supported the operation.操作失败，当前引擎不支持此操作，请升级内核小版本。
400IncorrectDBInstanceLockMode.ValueNotSupportedThe Current DB instance lock mode does not support this operation.操作失败，当前数据库实例锁模式不支持此操作。
400InvalidZoneId.NotNullThe parameter ZoneId must not be null or auto参数ZoneId不能为null或auto
400InvalidZoneId.NotEqualThe parameter ZoneId is the same as the previous one操作失败，两个可用区相同。
400InvalidDispenseMode.FormatThe specified dispense mode is not valid.-
400IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.操作失败，该实例状态下不支持此操作。
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.具有预检查的请求实例的可用容量不足。
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 operation开启SSL功能的实例不支持此操作
400BYOLInstanceNotSupportThisOperationThe BYOL instance is not supported this operationBYOL实例不支持此操作
400BYOKInstanceNotSupportThisOperationThe BYOK instance is not supported this operation开启云盘加密功能的实例不支持此操作
400ADInstanceNotSupportThisOperationThe AD instance is not supported this operation加入AD域的实例不支持此操作
400TDEInstanceNotSupportThisOperationThe instance opened TDE, this operation is not supported开启TDE功能的实例不支持此操作
400InstanceIsSnapshotBackupNotSupportThisOperationThe instance backup method is snapshot backup, this operation is not supported开启快照备份的实例不支持此操作
400InstanceHasReadOnlyInstanceNotSupportThisOperationThe instance has read-only instance or is read-only instance, this operation is not supported该实例有只读实例或者该实例是只读实例，不支持此操作
400VswitchIpExhaustedNo available ip in the specified vswitch.指定的vswitch中没有可用的IP。
400OperationDenied.MasterDBInstanceStateThe operation is not permitted due to status of master instance.操作失败，当前只读实例正在变更，此状态下主实例不支持此操作，请等待只读实例完成后，再进行重试。
400InvalidShareInstance.NotSupportThe share dbInstance is not support.共享型实例不支持
400InvalidZoneIdSlave1.MissingThe parameter ZoneIdSlave1 must be specified.备可用区ID不能为空。
400MigrateAlreadyExistsFaultThe rds instance already has a given vpc migrate task.RDS实例档已存在一个VPC迁移任务。
400InvalidInstanceKind.NotSupportThe instance kind does not support this operation.实例类型不支持此操作。
400MissingCategoryThe instance is missing a category parameter.实例缺少类别参数。
400InvalidInstanceNodeType.NotFoundThe specified NodeType is not found.NodeType参数缺失，请重新配置。
400EngineVersionNotSupportedEngineVersion specified cannot be replicate with the source DB Instance.当前数据库引擎版本不支持克隆实例。
400CommodityCodeNotFoundCommodityCodeNotFound指定的参数CommodityCode无效，请检查该参数的正确性。
400InvalidTunnelIdSpecified conn tunnel is not valid.指定的连接通道无效。
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing 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.您还未通过实名认证，不符合购买条件，请登录用户中心进行实名认证。
400InsufficientAvailableQuotaYour account quota limit is less than 0, please recharge before trying to purchase.您的账户可用额度小于0，请先充值后再尝试购买。
400CommodityServiceCalling.ExceptionFailed to call commodity service.调用商品服务返回失败。
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.客户您好，阿里云计划对当前地域进行优化调整，该区域云服务将停止运营，为确保您的业务连续性及数据迁移工作的平稳过渡，您目前无法操作新购类型的订单，感谢理解与支持。
400Commodity.InvalidComponentThe 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.客户您好，印度地域裁撤，购买的服务效期不能超过2024.07.15。
400RegionEndTimeDissolvedAustraliaCloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.客户您好，澳洲地域裁撤，购买的服务效期不能超过2024.09.30
400Price.CommoditySysCommodity system call exception.商品系统调用异常。
400Pay.InsufficientBalanceInsufficient available balance.可用金不足。
400Order.PeriodInvalidThere 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.您选购的服务存在未支付订单，请支付或作废后再下单。
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.您的基本信息未完善，请在操作前先完善您的基本信息。
400Risk.RiskControlRejectionYour 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.当前接口不支持。
400ContainForbiddenLabelErrorThere is a label that prohibits placing orders. Please contact your distributor for assistance.存在禁止下单的标签，请联系您的分销商处理
400InvalidDBInstanceId.NotFoundThe DBInstanceId provided does not exist in records.提供的DBInstanceId不存在。
400InvalidInstanceLevel.DiskTypeSpecified instance level not support request disk type当前实例规格不支持该存储类型。
400InvalidParamSepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.指定的 wal_level 参数无效。实例中仍然存在复制槽，因此无法将其设置为replica。
400KmsApiErrorUser secret key invalid.用户密钥失效。
400System.SaleValidateFailedSales expression validation system error.销售表达式校验系统错误。
400Abs.InvalidAccount.NotFoundaccount is not found.账户不存在。
400SqlExecuteFailedOrTimeoutsql command execution failed or timed out:%s.sql命令执行失败或执行超时
400ColdData.EngineVersionNotSupportThe current instance engine version not support coldDataEnabled.当前实例引擎版本不支持归档冷数据。
400ColdData.MinorVersionNotSupportThe current instance minor version not support coldDataEnabled.当前内核版本不支持归档冷数据。
400IncorrectTargetClasscodeThe current instance type does not support this operation.当前规格不支持此操作。
400InvalidConnectionString.DuplicateSpecified connection string already exists in the RDS.链接地址名重复，请重新设置连接字符串。
400RequiredParam.NotFoundRequired input param is not found.没有传入必要的参数。
400Parameters.InvalidParameter error, please check the parameters.参数错误，请检查参数。
400BackupPolicyNotSupportCold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.数据归档不支持跨地域备份和秒级快照，请检查备份策略。
400InvalidReleasedKeepPolicy.FormatSpecified Released Keep Policy is not valid.实例释放后的归档备份保留策略无效。
400InvalidDBInstanceEngineType.Formatthe DB instance engine type does not support this operation.DB实例引擎类型不支持此操作。
400Pay.NoCreditCardNo credit cards.无信用卡。
400VpcNetworkTypeNotSupportThe vpc network type instance does not support this operation.vpc网络类型实例不支持此操作。
400UnsupportedClassCodeThe specified DB instance class stops selling.实例规格停止售卖。
400InvalidBackupSetThe specified database does not exist in the backup set.备份集中没有指定的数据库。
403OperationDenied.OutofUsageThe resource is out of usage.当前集群的资源不足，请选择其它可用区。
403IncorrectEffectiveTimeThe specified EffectiveTime params is not valid.EffectiveTime参数无效。
403InvalidTempInstance.NotSupportThe temp db Instance is not support.操作失败，当前实例已被锁定。
403OperationDenied.LockModeThe operation is not permitted due to instance being locked.实例锁定中，不支持该操作。请检查实例的存储空间是否已满，或者实例是否已到期。若磁盘空间已满，请进行变更配置，扩大存储空间后即可解锁；若实例已到期，续费后即可解锁。
403ClassicNetworkType.NotSupportThe Classic instance network create is not support.操作失败，当前实例不支持创建经典网络类型，请创建其他网络类型的实例。
403InstanceNetworkTypeNotFoundFaultThe specified DBInstanceNetworkType is not found.检查网络类型失败，实例网络类型不存在。
403ProprietaryCloud.NotSupportedThe proprietary cloud not supported.专有云不支持。
403MigrateAlreadyReadWriteSplitExistsFaultThe rds instance already has a given vpc migrate task.RDS实例已存在指定VPC迁移任务。
403InvalidRegionAvzNotFoundSpecified user does not find the region and avz.指定的用户找不到区域和avz。
403ZoneIdNotSupportedThe zone ID is not supported.操作失败，不支持区域ID。
403InvalidVpcInfo.NotFoundSpecified VPC info does not exist.指定的VPC信息不存在。
403InvalidMultiparamZoneInfoListZoneinfo list is invaild.当前主可用区未对齐，无法迁移主库
403MigrateSlaveNotSupportCurrent DB instance state does not support migrating slave, please switch the Primary/Secondary Instance first.当前实例的状态不支持仅迁移备库，强行迁移会导致访问数据库的性能下降，请先做一次 HA 切换。
403CloudDiskEncryptionNotSupportThe encryption key is not allowed for general-purpose instance.通用型规格实例不支持云盘加密。
403OrderStatus.UnPaidThe specified db instance has unpaid order.实例当前存在未支付订单，请支付后重试。
403InvalidReduceDiskSizeThe storage capacity after the scale-down must be larger than the used amount.缩容目标容量不能小于当前存储空间使用量
403CloudSSDNotSupportCloud ssd does not support this operation, please upgrade to essd.SSD盘不支持此操作，请升级至ESSD。
403InvalidUserOperatorPermissionThe user permission does not support this operation.用户权限不支持此操作。
403InvalidVswitchIdSpecified conn vswitch id is not valid.指定的VSwitchId格式不正确或为空
403IncorrectMinorVersionCurrent engine minor version does not support operations.当前引擎小版本不支持此操作。
403OperationDenied.ZoneResourceThere is no available zone for inventory.没有可用的库存区域。
403NotInFlowControllerSorry,no permission.非集团上云用户不可用，无权限。
403InvalidKmsKeyKms key is disabled.Kms key已禁用。
403InvalidInstanceLevel.MalformedCurrent DB instance level does not support this operation.当前数据库实例级别不支持此操作。
404InvalidDBInstanceName.NotFoundThe database instance does not exist.数据库实例名称不存在。请确认数据名称是否正确。
404IncorrectVswitchIdThe specified parameter VSwitchId is not valid.交换机参数无效。
404InvalidClusterKmsThe current instance does not authorized to access the Key Management Service.当前实例未授权访问密钥管理服务。
404Request.NotFoundThe requested resource is not available.请求的资源不可用。
404HostInfo.NotFoundThe specified host info is not found.指定的主机信息不存在。
500ExternalFailureThe request processing has failed due to external service failure.请求服务失败，请稍后重试。
500RequestMetaDataFailedThe service request failed. Please try again later or contact service personnel.请求服务失败，请稍后再试或联系服务人员。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2024-06-03OpenAPI 错误码发生变更查看变更详情
2024-04-17OpenAPI 错误码发生变更查看变更详情
2024-01-04OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
2023-03-31OpenAPI 错误码发生变更查看变更详情
2023-03-01OpenAPI 错误码发生变更查看变更详情
2022-10-28OpenAPI 错误码发生变更查看变更详情
2022-10-13OpenAPI 错误码发生变更查看变更详情
2022-06-23OpenAPI 错误码发生变更查看变更详情
2022-06-08OpenAPI 错误码发生变更查看变更详情
2022-01-12OpenAPI 错误码发生变更、OpenAPI 入参发生变更、OpenAPI 返回结构发生变更查看变更详情
2021-10-26OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
上一篇：ModifyDasInstanceConfig - 设置存储空间自动扩容下一篇：ModifyDBInstanceDescription - 修改实例名称
文档推荐