全部产品
Search
文档中心

云数据库 RDS:SwitchDBInstanceNetType - 切换内外网地址

更新时间:May 29, 2023

切换内外网地址。

接口说明

为了节约地址资源,您可以使用该接口进行内外网切换,即原来是内网,则会切换到外网,反之亦然。切换后连接地址会发生变化,需要您修改代码中的连接地址并重启应用。

必须满足以下条件,否则将修改失败:

  • 实例只有内网地址和外网地址其中一个。
  • 实例状态为运行中。
  • 24小时内切换次数低于20次。
  • 实例的网络类型为经典网络。

调试

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

调试

授权信息

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

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

请求参数

名称类型必填描述示例值
ClientTokenstring

用于保证请求的幂等性,防止重复提交请求。由客户端生成该参数值,要保证在不同请求间唯一,最大值不超过64个ASCII字符,且该参数值中不能包含非ASCII字符。

ETnLKlblzczshOTUbOCzxxxxxx
DBInstanceIdstring

实例ID。

rm-bp1**************
ConnectionStringPrefixstring

自定义连接地址的前辍。由字母,数字组成,小写字母开头,8~64个字符。完整连接地址为:前缀.引擎名.rds.aliyuncs.com。例如test1234.mysql.rds.aliyuncs.com。

new**********
Portstring

端口号,取值:3001~3999

3306
ConnectionStringTypestring

连接地址类型,取值:

  • Normal:普通连接
  • ReadWriteSplitting:读写分离连接

默认返回所有连接。

Normal

返回参数

名称类型描述示例值
object
NewConnectionStringstring

切换后的数据库连接地址。

new**********.mysql.rds.aliyuncs.com
RequestIdstring

请求ID。

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

切换前的数据库连接地址。

rm-bp1**************.mysql.rds.aliyuncs.com

示例

正常返回示例

JSON格式

{
  "NewConnectionString": "new**********.mysql.rds.aliyuncs.com",
  "RequestId": "65BDA532-28AF-4122-AA39-B382721EEE64",
  "OldConnectionString": "rm-bp1**************.mysql.rds.aliyuncs.com"
}

错误码

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

变更历史

变更时间变更内容概要操作
2022-06-23OpenAPI 描述信息更新
变更项变更内容
API 描述OpenAPI 描述信息更新