该接口用于迁移RDS实例的可用区。
接口说明
适用引擎
RDS MySQL
RDS PostgreSQL
RDS SQL Server
相关功能文档
重要 使用该接口前，请仔细阅读功能文档，确保完全了解使用接口的前提条件及使用后造成的影响后，再进行操作。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| DBInstanceId |
string |
是 |
实例 ID。可调用 DescribeDBInstances 获取。 |
rm-uf6wjk5**** |
| VPCId |
string |
否 |
专有网络 VPC ID。迁移可用区时 VPC 不能变更，需保持不变。
|
vpc-**** |
| ZoneId |
string |
是 |
目标可用区 ID，可调用 DescribeRegions 获取。 |
cn-hangzhou-b |
| EffectiveTime |
string |
否 |
生效时间，取值：
说明
如果在本参数中传入 ScheduleTime，则还需要传入 SwitchTime 参数。 |
Immediate |
| VSwitchId |
string |
否 |
交换机 ID。
|
vsw-uf6adz52c2p**** |
| Category |
string |
否 |
实例系列，取值：
|
HighAvailability |
| ZoneIdSlave1 |
string |
否 |
备可用区 1。 说明
非基础系列实例需要传入该参数。 |
cn-hangzhou-c |
| ZoneIdSlave2 |
string |
否 |
备可用区 2。 说明
仅三节点企业系列实例可传入该参数。 |
cn-hangzhou-d |
| SwitchTime |
string |
否 |
切换可用区的自定义生效时间。格式：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。 说明
本参数配合 EffectiveTime 参数使用，仅在 EffectiveTime 为 ScheduleTime 时需要传入。 |
2021-12-14T15:15:15Z |
| IsModifySpec |
string |
否 |
是否在迁移可用区时变配。
说明
该参数仅 RDS MySQL 实例适用。 |
true |
| DBInstanceClass |
string |
否 |
目标实例规格代码，只支持变更规格，不支持变更存储类型。 当 IsModifySpec 参数配置为 true 时，至少需要配置本参数和 DBInstanceStorage 中的一个。 实例规格代码请参见RDS MySQL 主实例规格列表。 |
mysql.x4.xlarge.2 |
| DBInstanceStorage |
integer |
否 |
目标存储空间大小。当 IsModifySpec 参数配置为 true 时，至少需要配置本参数和 DBInstanceClass 中的一个。 单位：GB。 取值范围：不同规格可扩容存储空间大小不同，具体请以RDS MySQL 主实例规格列表为准。 |
500 |
| IoAccelerationEnabled |
string |
否 |
高性能云盘的 Buffer Pool Extension（BPE）功能开关，参数：
说明
Buffer Pool Extension（BPE）功能的更多信息，请参见Buffer Pool Extension（BPE）。 |
0 |
| DBInstanceStorageType |
string |
否 |
实例存储类型，取值：
|
cloud_essd |
| CustomExtraInfo |
string |
否 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回参数详情。 |
||
| DBInstanceId |
string |
实例 ID。 |
rm-uf6wjk5**** |
| OrderId |
integer |
订单 ID，仅 MySQL 实例适用。 |
21334157599**** |
| RequestId |
string |
请求 ID。 |
65BDA532-28AF-4122-AA39-B382721EEE64 |
示例
正常返回示例
JSON格式
{
"DBInstanceId": "rm-uf6wjk5****",
"OrderId": 0,
"RequestId": "65BDA532-28AF-4122-AA39-B382721EEE64"
}错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 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. | 指定的参数DBInstanceClass或Storage无效. |
| 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 | 参数ZoneId不能为null或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 | 开启SSL功能的实例不支持此操作 |
| 400 | BYOLInstanceNotSupportThisOperation | The BYOL instance is not supported this operation | BYOL实例不支持此操作 |
| 400 | BYOKInstanceNotSupportThisOperation | The BYOK instance is not supported this operation | 开启云盘加密功能的实例不支持此操作 |
| 400 | ADInstanceNotSupportThisOperation | The AD instance is not supported this operation | 加入AD域的实例不支持此操作 |
| 400 | TDEInstanceNotSupportThisOperation | The instance opened TDE, this operation is not supported | 开启TDE功能的实例不支持此操作 |
| 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. | 指定的vswitch中没有可用的IP。 |
| 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. | 备可用区ID不能为空。 |
| 400 | MigrateAlreadyExistsFault | The rds instance already has a given vpc migrate task. | RDS实例档已存在一个VPC迁移任务。 |
| 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 | 指定的参数CommodityCode无效，请检查该参数的正确性。 |
| 400 | InvalidTunnelId | Specified conn tunnel is not valid. | 指定的连接通道无效。 |
| 400 | SSLNotSupport | The CharacterType of instance does not support SSL. | 实例的字符类型不支持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. | 您的账户可用额度小于0，请先充值后再尝试购买。 |
| 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. | 提供的DBInstanceId不存在。 |
| 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. | 指定的 wal_level 参数无效。实例中仍然存在复制槽，因此无法将其设置为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. | sql命令执行失败或执行超时 |
| 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. | DB实例引擎类型不支持此操作。 |
| 400 | Pay.NoCreditCard | No credit cards. | 无信用卡。 |
| 400 | VpcNetworkTypeNotSupport | The vpc network type instance does not support this operation. | vpc网络类型实例不支持此操作。 |
| 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. | Xfs实例必须是独享高可用实例。 |
| 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. | 由于rds api服务失败，请求处理失败。 |
| 403 | OperationDenied.OutofUsage | The resource is out of usage. | 当前集群的资源不足，请选择其它可用区。 |
| 403 | IncorrectEffectiveTime | The specified EffectiveTime params is not valid. | EffectiveTime参数无效。 |
| 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. | RDS实例已存在指定VPC迁移任务。 |
| 403 | InvalidRegionAvzNotFound | Specified user does not find the region and avz. | 指定的用户找不到区域和avz。 |
| 403 | ZoneIdNotSupported | The zone ID is not supported. | 操作失败，不支持区域ID。 |
| 403 | InvalidVpcInfo.NotFound | Specified VPC info does not exist. | 指定的VPC信息不存在。 |
| 403 | InvalidMultiparamZoneInfoList | Zoneinfo list is invaild. | 当前主可用区未对齐，无法迁移主库 |
| 403 | MigrateSlaveNotSupport | Current DB instance state does not support migrating slave, please switch the Primary/Secondary Instance first. | 当前实例的状态不支持仅迁移备库，强行迁移会导致访问数据库的性能下降，请先做一次 HA 切换。 |
| 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. | SSD盘不支持此操作，请升级至ESSD。 |
| 403 | InvalidUserOperatorPermission | The user permission does not support this operation. | 用户权限不支持此操作。 |
| 403 | InvalidVswitchId | Specified conn vswitch id is not valid. | 指定的VSwitchId格式不正确或为空 |
| 403 | OperationDenied.ZoneResource | There is no available zone for inventory. | 没有可用的库存区域。 |
| 403 | NotInFlowController | Sorry,no permission. | 非集团上云用户不可用，无权限。 |
| 403 | InvalidKmsKey | Kms key is disabled. | Kms key已禁用。 |
| 403 | InvalidInstanceLevel.Malformed | Current DB instance level does not support this operation. | 当前数据库实例级别不支持此操作。 |
| 403 | InstanceEngineType.NotSupport | The instance engine and type does not support operations. | RDS MySQL实例引擎和类型不支持此操作，请检查实例kindcode和内核小版本是否过低，升级内核小版本。 |
| 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. | 非xfs磁盘类型不支持升级到60T或更高。 |
| 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. | 指定的主机信息不存在。 |
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。