文档

CreateDBProxyEndpointAddress - 新增数据库代理的连接地址

更新时间:

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

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL

相关功能文档

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

调试

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

授权信息

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

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

请求参数

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

地域 ID。可调用 DescribeRegions 获取。

cn-hangzhou
DBInstanceIdstring

实例 ID。可调用 DescribeDBInstances 获取。

rm-t4n3****
DBProxyEndpointIdstring

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

ta9um4****
ConnectionStringPrefixstring

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

test1234
DBProxyNewConnectStringPortstring

新的数据库代理连接地址的端口,默认值:

  • MySQL:3306
  • PostgreSQL:5432
3306
DBProxyConnectStringNetTypestring

新的数据库代理连接地址的网络类型,取值:

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

默认值:Classic

Public
VPCIdstring

新的数据库代理连接地址的 VPC ID。可调用 DescribeDBInstanceAttribute 接口查询。

说明 DBProxyConnectStringNetType 取值为 VPC 时, 必须传入此参数。
vpc-bp****
VSwitchIdstring

新的数据库代理连接地址的虚拟交换机 ID。可调用 DescribeDBInstanceAttribute 接口查询。

说明 DBProxyConnectStringNetType 取值为 VPC 时, 必须传入此参数。
vsw-bp****
DBProxyEngineTypestring

预留参数,无需配置。

normal
ResourceGroupIdstring

资源组 ID。

rg-acfmy****

返回参数

名称类型描述示例值
object

返回参数详情。

RequestIdstring

请求 ID。

F2911788-25E8-42E5-A3A3-1B38D263F01E

示例

正常返回示例

JSON格式

{
  "RequestId": "F2911788-25E8-42E5-A3A3-1B38D263F01E"
}

错误码

HTTP status code错误码错误信息描述
400InvalidPort.MalformedSpecified port is not valid.指定的端口无效。
400NetTypeExistsSpecified net type already existed.网络类型切换失败,当前网络类型已经存在。
400IncorrectDBInstanceNetTypeCurrent DB instance net type does not support this operation.操作失败,实例网络类型不支持。
400InvalidConnectionString.DuplicateSpecified connection string already exists in the Aliyun RDS.链接地址名重复,请重新设置连接字符串。
400InvalidConnVPCIdSpecified conn vpc id is not valid.指定的连接专有网络ID无效。
400InvalidVpcInstanceIdSpecified vpc instance id is not valid.操作失败,当前VPC实例ID无效。
400InvalidDBInstanceNameSpecified parameter DBInstanceName is not valid.指定的实例名称(DBInstanceName)无效,请检查参数值是否为null或空字符串。
400InvalidVpcIdOrVswitchId.NotSupportedThe specified vpcId or vSwitchId is not supported.指定的vpcId或者vSwitchId不支持,请检查实例信息
400InvalidPrivateIpAddress.MismatchSpecified private IP address is not in the CIDR block of virtual switch.VPC地址无效。
400InvalidVpcParameterSpecified VPCId VSwitchId or IPAddress or TunnelId is not valid.VPCId VSwitchId不合法,请检查VPCId VSwitchId的正确性。
400InvalidBizType.FormatSpecified biz type is not valid.当前业务类型不支持该操作。
400InvalidVSwitchId.NotFoundSpecified vSwitch is not found in specified VPC.当前VPC内无可用交换机。
400InvalidVSwitchId.MismatchSpecified instance and virtual switch are not in the same zone.实例和交换机不在同一可用区。
400InvalidPrivateIpAddress.AlreadyUsedThe specified IP is already used.ip已被使用。
400VswitchIpExhaustedNo available ip in the specified vswitch.指定的vswitch中没有可用的IP。
400MaxscaleNotSupportCurrent custins can not support Maxscale.带有maxscale的实例不支持此操作。
400InvalidConnectionString.FormatSpecified connection string is not valid.实例连接地址的字符串格式不正确。字符串前缀长度为5~40。
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.您还未通过实名认证,不符合购买条件,请登录用户中心进行实名认证。
403IncorrectDBInstanceTypeCurrent DB instance type does not support this operation.操作失败,该实例状态下不支持此操作。
403IncorrectDBInstanceStateCurrent DB instance state does not support this operation.当前实例状态不支持此操作。
403IncorrectDBInstanceEngineCurrent DB Instance engine does not support this operation.操作失败,数据库引擎不支持。
403IncorrectKindCodeCurrent custins kindCode does not support this operation.操作失败,当前实例所属环境类型不支持,请检查接口支持的实例类型。
403IncorrectDBInstanceConnTypeCurrent DB instance conn type does not support this operation.当前数据库实例的连接类型不支持此操作。
404Endpoint.NotFoundSpecified endpoint is not found.未找到指定独享代理连接地址的端口。
404Maxscale.NotFoundThe related maxscale instance is not found.操作失败,未找到关联的maxscale实例。
404IncorrectVswitchIdThe specified parameter VSwitchId is not valid.交换机参数无效。
404InvalidDBInstanceName.NotFoundInvalid DBInstanceId NotFound.数据库实例ID不存在,请检查。
404InvalidDBInstance.NotFoundSpecified instance does not exist or not support.指定的实例不存在指定的实例被删除或者实例不支持当前操作。
404InsufficientResourceCapacityCurrent cluster resources are insufficient. Try again later.当前集群的资源不足,请您稍后再试。

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

变更历史

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