该接口用于迁移RDS实例的可用区。
接口说明
适用引擎
- RDS MySQL
- RDS PostgreSQL
- RDS SQL Server
相关功能文档
注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。
- RDS MySQL迁移可用区
- RDS PostgreSQL迁移可用区
- RDS SQL Server迁移可用区
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI
Explorer可以自动生成SDK代码示例。
调试调试
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:MigrateToOtherZone | WRITE |
|
|
无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 |
实例ID。可调用DescribeDBInstances获取。 |
rm-uf6wjk5**** |
VPCId | string | 否 |
专有网络VPC ID。迁移可用区时VPC不能变更,需保持不变。
|
vpc-**** |
ZoneId | string | 是 |
目标可用区ID,可调用DescribeRegions获取。 |
cn-hangzhou-b |
EffectiveTime | string | 否 |
生效时间,取值:
说明 | 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时间)。 说明 | 2021-12-14T15:15:15Z |
IsModifySpec | string | 否 | 是否在迁移可用区时变配。
说明 | true |
DBInstanceClass | string | 否 | 目标实例规格代码,只支持变更规格,不支持变更存储类型。 实例规格代码请参见RDS MySQL主实例规格列表。 |
mysql.x4.xlarge.2 |
DBInstanceStorage | long | 否 |
目标存储空间大小。当IsModifySpec参数配置为true时,至少需要配置本参数和DBInstanceClass中的一个。 单位:GB。 |
500 |
返回参数
名称 | 类型 | 描述 | 示例值 |
---|---|---|---|
object |
返回参数详情。 |
||
RequestId | string |
请求ID。 |
65BDA532-28AF-4122-AA39-B382721EEE64 |
DBInstanceId | string |
实例ID。 |
rm-uf6wjk5**** |
OrderId | long |
订单ID,仅MySQL实例适用。 |
21334157599**** |
示例
正常返回示例
JSON
格式
{
"RequestId": "65BDA532-28AF-4122-AA39-B382721EEE64",
"DBInstanceId": "rm-uf6wjk5****",
"OrderId": 0
}
错误码
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. | NodeType参数缺失,请重新配置。 |
400 | EngineVersionNotSupported | EngineVersion specified cannot be replicate with the source DB Instance. | 当前数据库引擎版本不支持克隆实例。 |
400 | CommodityCodeNotFound | CommodityCodeNotFound | 指定的参数CommodityCode无效,请检查该参数的正确性。 |
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. | 当前主可用区未对齐,无法迁移主库 |
404 | InvalidDBInstanceName.NotFound | The database instance does not exist. | 数据库实例名称不存在。请确认数据名称是否正确。 |
404 | IncorrectVswitchId | The specified parameter VSwitchId is not valid. | 交换机参数无效。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
2023-03-31 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||||
|
||||||||||||||||||
2023-03-01 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||||
|
||||||||||||||||||
2022-10-28 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||||
|
||||||||||||||||||
2022-10-13 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||||
|
||||||||||||||||||
2022-06-23 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||||
|
||||||||||||||||||
2022-06-08 | OpenAPI 错误码发生变更 | 看变更集 | ||||||||||||||||
|
||||||||||||||||||
2022-01-12 | OpenAPI 错误码发生变更,OpenAPI 入参发生变更,OpenAPI 返回结构发生变更 | 看变更集 | ||||||||||||||||
|
||||||||||||||||||
2021-10-26 | OpenAPI 错误码发生变更,OpenAPI 入参发生变更 | 看变更集 | ||||||||||||||||
|
内容没看懂? 不太想学习?想快速解决? 有偿解决: 联系专家
阿里云企业补贴进行中: 马上申请
腾讯云限时活动1折起,即将结束: 马上收藏
同尘科技为腾讯云授权服务中心。
购买腾讯云产品享受折上折,更有现金返利:同意关联,立享优惠
转转请注明出处:https://www.yunxiaoer.com/156033.html