文档

SwitchDBInstanceNetType - 切换经典网络内外网地址

更新时间:

该接口用于切换经典网络实例的内外网地址。

接口说明

适用引擎

  • RDS MySQL
  • RDS SQL Server

前提条件

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

注意事项

切换后连接地址会发生变化,需要您修改代码中的连接地址并重启应用。

调试

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

授权信息

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

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

请求参数

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

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

ETnLKlblzczshOTUbOCz****
DBInstanceIdstring

实例 ID。可调用 DescribeDBInstances 获取。

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"
}

错误码

HTTP status code错误码错误信息描述
400Order.ComboInstanceNotAllowOperateA package instance is not allowed to operate independently.套餐实例不允许单独操作。
400Price.PricingPlanResultNotFoundPricing plan price result not found.定价计划价格结果没有找到。
400Order.NoRealNameAuthenticationYou 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.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。

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

变更历史

变更时间变更内容概要操作
2022-06-23OpenAPI 描述信息更新看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
  • 本页导读 (1)
文档反馈