文档

ModifyDBInstanceConnectionString - 修改实例的连接地址和端口

更新时间:

该接口用于修改实例的连接地址和端口。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL
  • RDS SQL Server
  • RDS MariaDB

相关功能文档

注意 使用该接口前,请仔细阅读功能文档,确保完全了解使用接口的前提条件及使用后造成的影响后,再进行操作。

调试

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

授权信息

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

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

请求参数

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

实例 ID。可调用 DescribeDBInstances 获取。

rm-uf6wjk5****
CurrentConnectionStringstring

实例当前的某个连接地址,可以是内外网连接地址,或者混访模式下的经典网络连接地址。

说明 不支持修改读写分离连接地址。
rm-uf6wjk5x****.mysql.rds.aliyuncs.com
ConnectionStringPrefixstring

目标连接地址的前缀,即只能修改 CurrentConnectionString 参数的前缀部分。

说明 长度 8~64,不能包含汉字和非法字符(~!#%^&*=+|{};:'",<>/?),建议由字母、数字、短横线(-)组成。
rm-****
Portstring

目标端口。

3306
BabelfishPortstring

Babelfish for RDS PostgreSQL TDS 端口号。

说明 该参数仅适用于 RDS PostgreSQL 实例,Babelfish for RDS PostgreSQL 的更多介绍,请参见 Babelfish 简介
1433
GeneralGroupNamestring

专属集群 MySQL 通用版实例所属的组名。

rgc-bp1tkv8****
PGBouncerPortstring

PgBouncer 端口号。

说明 该参数仅适用于 RDS PostgreSQL 实例,如果开启了 PgBouncer,则支持修改 PgBouncer 端口号。
6432

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求 ID。

65BDA532-28AF-4122-AA39-B382721EEE64

示例

正常返回示例

JSON格式

{
  "RequestId": "65BDA532-28AF-4122-AA39-B382721EEE64"
}

错误码

HTTP status code错误码错误信息描述
400DnsConflictDns is conflict with other custins.DNS与其他客户端冲突。
400InvalidConnectionString.MalformedThe specified parameter ConnectionStringPrefix is not valid.-
400OperationDenied.DBInstanceStatusThe operation is not permitted due to status of instance.操作失败,当前实例状态不支持此操作。
400InvalidConnectionString.NotFoundThe specified connection string or network type is not found.连接串不存在。请检查连接串是否正确。
400MissingConnectionStringThe request is missing a ConnectionString parameter.操作失败,请求缺少要延期的经典网络连接地址(ConnectionString)。
400OtherEndpoint.ExistOther endpoint exist.外网连接地址的前缀已存在
400Endpoint.NotFoundSpecified endpoint is not found.未找到指定独享代理连接地址的端口。
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.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
404InvalidConnectionString.DuplicateSpecified connection string already exists in the Aliyun RDS.链接地址名重复,请重新设置连接字符串。

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

变更历史

变更时间变更内容概要操作
2023-06-27OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:PGBouncerPort
2022-09-01OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2022-06-23OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2022-04-25OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
2022-04-25OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
入参OpenAPI 入参发生变更
    新增入参:BabelfishPort
  • 本页导读 (1)
文档反馈