该接口用于将经典网络的RDS实例切换为VPC网络。
接口说明
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
rds:ModifyDBInstanceNetworkType | WRITE |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 | 实例ID。可调用DescribeDBInstances获取。 | rm-uf6wjk5**** |
RetainClassic | string | 否 | 是否保留经典网络地址,取值:
| True |
ClassicExpiredDays | string | 否 | 经典网络地址保留的天数,取值1-120,单位:天。默认值:7。 说明
若传入参数RetainClassic=True,则该参数必传。
| 7 |
InstanceNetworkType | string | 是 | 目标网络类型,取值固定为VPC:专有网络。 | VPC |
ReadWriteSplittingClassicExpiredDays | integer | 否 | 读写分离的经典网络地址保留的天数,取值1-120,单位:天。默认值:7。 说明
当实例存在经典网络类型的读写分离地址,且RetainClassic=True,本参数有效。
| 7 |
VPCId | string | 否 | VPC ID。 | vpc-uf6f7l4fg90**** |
VSwitchId | string | 否 | 交换机ID,若传入VPCId,则该参数必传。 | vsw-uf6adz52c2p**** |
PrivateIpAddress | string | 否 | 设置实例的内网IP,需要在指定交换机的IP地址范围内。系统默认通过VPCId和VSwitchId自动分配。 | 172.10.XX.XX |
ReadWriteSplittingPrivateIpAddress | string | 否 | 设置实例的内网读写分离地址的IP,需要在指定交换机的IP地址范围内。系统默认通过VPCId和VSwitchId自动分配。 说明
当前实例存在经典网络类型的读写分离地址时,该值有效。
| 192.168.XX.XX |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "1AD222E9-E606-4A42-BF6D-8A4442913CEF",
"TaskId": "1025486523574",
"ConnectionString": "rm-bp1****.mysql.rds.aliyuncs.com"
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | NetTypeExists | Specified network type already exists. | 网络类型切换失败,当前网络类型已经存在。 |
400 | VswitchIpExhausted | Vswitch IP exhausted. | 操作失败,vSwitch IP耗尽。 |
400 | OperationDenied.Switch | The specified instance must not be switched to VPC. | 操作失败,当前实例不支持切换至专有网络。 |
400 | OperationDenied.DBInstanceNetType | Operation is denied by the network type of current database instance. | 操作失败,数据库实例的网络类型不支持此操作。 |
400 | OperationDenied.DBInstanceStatus | Operation is denied by the current database instance status. | 操作失败,当前数据库实例状态不支持。 |
400 | OperationNotSupported | This operation is not currently supported. | 目前不支持此操作 |
403 | OperationDenied.DBInstanceConnType | The current DB instance connection type does not support this operation. | 操作失败,当前的网络连接类型不支持该操作。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
2022-06-23 | OpenAPI 描述信息更新,OpenAPI 错误码发生变更 | 看变更集 | ||||||||
|