调用SwitchDBInstanceNetType接口切换内外网地址。
为了节约地址资源,您可以使用该接口进行内外网切换,即原来是内网,则会切换到外网,反之亦然。切换后连接地址会发生变化,需要您修改代码中的连接地址并重启应用。
必须满足以下条件,否则将修改失败:
- 实例只有内网地址和外网地址其中一个。
- 实例状态为运行中。
- 24小时内切换次数低于20次。
- 实例的网络类型为经典网络。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
| 名称 | 类型 | 是否必选 | 示例值 | 描述 |
|---|---|---|---|---|
| Action | String | 是 | SwitchDBInstanceNetType |
系统规定参数。取值:SwitchDBInstanceNetType。 |
| ClientToken | String | 否 | ETnLKlblzczshOTUbOCzxxxxxx |
用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。 |
| DBInstanceId | String | 是 | rm-bp1************** |
实例ID。 |
| ConnectionStringPrefix | String | 是 | new********** |
自定义连接地址的前辍。由字母,数字组成,小写字母开头,8~64个字符。完整连接地址为:前缀.引擎名.rds.aliyuncs.com。例如test1234.mysql.rds.aliyuncs.com。 |
| Port | String | 否 | 3306 |
端口号,取值:3001~3999。 |
| ConnectionStringType | String | 否 | Normal |
连接地址类型,取值:
默认返回所有连接。 |
返回数据
| 名称 | 类型 | 示例值 | 描述 |
|---|---|---|---|
| NewConnectionString | String | new**********.mysql.rds.aliyuncs.com |
切换后的数据库连接地址。 |
| RequestId | String | 65BDA532-28AF-4122-AA39-B382721EEE64 |
请求ID。 |
| OldConnectionString | String | rm-bp1**************.mysql.rds.aliyuncs.com |
切换前的数据库连接地址。 |
示例
请求示例
http(s)://rds.aliyuncs.com/?Action=SwitchDBInstanceNetType
&DBInstanceId=rm-uf6wjk5xxxxxxx
&ConnectionStringPrefix=rm-xxxxxx
&<公共请求参数>
正常返回示例
XML格式
HTTP/1.1 200 OK
Content-Type:application/xml
<SwitchDBInstanceNetTypeResponse>
<RequestId>94D5FC3C-1314-5883-9127-61D2105515AF</RequestId>
<OldConnectionString>rm-bp1qp11x5**************.rds.aliyuncs.com</OldConnectionString>
<NewConnectionString>new**********.rds.aliyuncs.com</NewConnectionString>
</SwitchDBInstanceNetTypeResponse>
JSON格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "94D5FC3C-1314-5883-9127-61D2105515AF",
"OldConnectionString" : "rm-bp1qp11x5**************.rds.aliyuncs.com",
"NewConnectionString" : "new**********.rds.aliyuncs.com"
}
错误码
访问错误中心查看更多错误码。