文档

ModifyDBProxyEndpointAddress - 修改数据库代理的连接地址

更新时间:

该接口用于修改RDS实例数据库代理的连接地址。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL

相关功能文档

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

调试

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

调试

授权信息

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

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

请求参数

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

实例 ID。可调用 DescribeDBInstances 获取。

rm-t4n3a****
DBProxyEndpointIdstring

数据库代理连接地址 ID。可以通过接口 DescribeDBProxyEndpoint 查询。

ta9um4****
DBProxyNewConnectStringstring

目标数据库代理连接地址的前缀。自定义。

说明 至少传入 DBProxyNewConnectStringDBProxyNewConnectStringPort 其中一个参数。
test123456
DBProxyNewConnectStringPortstring

目标数据库代理连接地址的端口。自定义。

说明 至少传入 DBProxyNewConnectStringDBProxyNewConnectStringPort 其中一个参数。
3307
DBProxyConnectStringNetTypestring

需要修改的数据库代理连接地址的网络类型,取值:

  • Public:公网
  • VPC:内网(专有网络)
  • Classic:内网(经典网络)

MySQL 默认值:Classic

说明 RDS PostgreSQL 时,该参数必选,支持 PublicVPC
Public
DBProxyEngineTypestring

废弃参数,无需配置。

normal

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求 ID。

50F6C32B-DD73-4DA1-ADA2-0EAF2B0FCD8A

示例

正常返回示例

JSON格式

{
  "RequestId": "50F6C32B-DD73-4DA1-ADA2-0EAF2B0FCD8A"
}

错误码

HTTP status code错误码错误信息描述
400InvalidConnectionString.FormatSpecified connection string is not valid.实例连接地址的字符串格式不正确。字符串前缀长度为5~40。
400InvalidPort.MalformedSpecified port is not valid.指定的端口无效。
400InvalidConnectionString.DuplicateSpecified connection string already exists in the Aliyun RDS.链接地址名重复,请重新设置连接字符串。
400InvalidConnectionStringOrPort.DuplicateSpecified connection string or port want to be modified is the same with current net type.连接串或端口号重复,请修改。
400InvalidDBInstanceNameSpecified parameter DBInstanceName is not valid.指定的实例名称(DBInstanceName)无效,请检查参数值是否为null或空字符串。
400OtherEndpoint.ExistOther endpoint already exist.endpoint已存在。
400MaxscaleNotSupportCurrent custins can not support Maxscale.带有maxscale的实例不支持此操作。
400ParameterLeastAssociateMust input at least one optional parameter必须输入至少一个可选参数。
403ParameterLeastAssociateMust input at least one optional parameter.还原时间或备份集不能同时为空,请设置后重试。
403NetTypeChangeTimesExceededExceeding the daily net type change times of the DB instance.-
403IncorrectDBInstanceEngineCurrent DB Instance engine does not support this operation.操作失败,数据库引擎不支持。
403IncorrectKindCodeCurrent custins kindCode does not support this operation.操作失败,当前实例所属环境类型不支持,请检查接口支持的实例类型。
403IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.操作失败,该实例状态下不支持此操作。
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.当前实例状态不支持此操作。
404InvalidConnectionString.NotFoundSpecified connection string or net type is not found.连接串不存在。请检查连接串是否正确。
404InsufficientResourceCapacityThere is insufficient capacity available for the requested instance.-
404Endpoint.NotFoundSpecified endpoint is not found.未找到指定独享代理连接地址的端口。
404Maxscale.NotFoundThe related maxscale instance is not found.操作失败,未找到关联的maxscale实例。

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

变更历史

变更时间变更内容概要操作
2023-12-19OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    错误码 403 变更
    错误码 404 变更
2023-09-08OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
2022-06-08OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:DBProxyEngineType
  • 本页导读 (1)
文档反馈