首页 云数据库 RDS 开发参考 API参考 API目录 数据库独享代理(读写分离) DescribeDBProxyEndpoint - 查询RDS实例独享代理的连接地址信息

DescribeDBProxyEndpoint - 查询RDS实例独享代理的连接地址信息

更新时间: 2023-11-30 12:09:52

该接口用于查询RDS实例独享代理的连接地址信息。

接口说明

适用引擎

  • RDS MySQL
  • RDS PostgreSQL

调试

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

调试

授权信息

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

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

请求参数

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

实例ID。可调用DescribeDBInstances获取。

rm-bp1ja4f56s7us****
DBProxyEndpointIdstring

代理终端名称。可调用DescribeDBProxy接口查询。

keaxncrjluwu0gue****
DBProxyConnectStringstring

代理连接地址。可调用DescribeDBProxy接口查询。

testproxy****.rwlb.rds.aliyuncs.com
RegionIdstring

地域ID。可调用DescribeRegions获取。

cn-hangzhou
DBProxyEngineTypestring

预留参数,无需配置。

normal

返回参数

名称类型描述示例值
object

返回参数详情。

DBProxyConnectStringNetTypestring

代理连接地址的网络类型,取值:

  • InnerString:内网地址。
  • OuterString:外网地址。
InnerString
DBProxyFeaturesstring

代理终端的设置信息,格式为JSON,包含下述参数:

  • TransactionReadSqlRouteOptimizeStatus:事务拆分设置,取值为0(关闭)或1(开启)。
  • ConnectionPersist:连接池设置:取值为0(关闭)、1(会话级连接池)或2(事务级连接池)。
  • ReadWriteSpliting:读写分离设置,取值为0(关闭)或1(开启)。
  • PinPreparedStmt:仅RDS PostgrSQL可见,内部参数。
说明 RDS PostgreSQL仅支持修改ReadWriteSplitingTransactionReadSqlRouteOptimizeStatusPinPreparedStmt默认为1。
TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1
RequestIdstring

请求ID。

847BA085-B377-4BFA-8267-F82345ECE1D2
ReadOnlyInstanceWeightstring

读权重分配信息,即传入主实例和只读实例的读请求权重,格式为JSON,包含下述参数:

  • DBInstanceId:实例ID。
  • DBInstanceType:实例类型,取值为Master(主实例)或ReadOnly(只读实例)。
  • NodeID:集群系列中主实例主节点和备节点的节点ID。
  • NodeType:集群系列中的节点类型,取值为Primary(主实例-主节点)或Secondary(主实例-备节点)。
  • Weight:读请求权重,以100递增,最大值为10000
[{\"Availability\":\"Available\",\"DBInstanceId\":\"rm-2z****\",\"DBInstanceType\":\"Master\",\"NodeId\":\"rn-t2****\",\"NodeType\":\"Primary\",\"Weight\":0}, {\"Availability\":\"Available\",\"DBInstanceId\":\"rm-2z****\",\"DBInstanceType\":\"Master\",\"NodeId\":\"rn-z9****\",\"NodeType\":\"Secondary\",\"Weight\":400}, {\"Availability\":\"Available\",,\"DBInstanceId\":\"rm-2z****\",\"DBInstanceType\":\"Master\",\"NodeId\":\"rn-1c****\",\"NodeType\":\"Secondary\",\"Weight\":400}]]
ReadOnlyInstanceDistributionTypestring

读权重分配模式,详情请参见读权重分配。取值:

  • Standard:按规格权重自动分配。
  • Custom:自定义分配权重。
Standard
ReadOnlyInstanceMaxDelayTimestring

读写分离的延迟阈值,当只读实例延迟时间超过该阈值时,读取流量不发往该实例,单位:秒。

30
DbProxyEndpointReadWriteModestring

代理终端的读写类型,取值:

  • ReadWrite:读写模式。
  • ReadOnly:只读模式。
ReadWrite
DbProxyEndpointAliasesstring

代理终端的备注信息。

proxyterminal-test
DBProxyEndpointIdstring

代理连接地址ID。

keaxncrjluwu0gue****
DBProxyConnectStringPortstring

代理连接地址端口。

3306
DBProxyConnectStringstring

代理连接地址。

testproxy****.rwlb.rds.aliyuncs.com
DBProxyEngineTypestring

内部参数,无需关注。

normal
EndpointConnectItemsobject []

代理连接地址的详细信息列表。

DbProxyEndpointPortstring

服务端口,默认为3306

3306
DbProxyEndpointConnectStringstring

代理连接地址。

testproxy****.rwlb.rds.aliyuncs.com
DbProxyEndpointNetTypestring

网络类型,取值:

  • 0:公网
  • 1:经典网络
  • 2:专有网络
2

示例

正常返回示例

JSON格式

{
  "DBProxyConnectStringNetType": "InnerString",
  "DBProxyFeatures": "TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1",
  "RequestId": "847BA085-B377-4BFA-8267-F82345ECE1D2",
  "ReadOnlyInstanceWeight": "[{\\\"Availability\\\":\\\"Available\\\",\\\"DBInstanceId\\\":\\\"rm-2z****\\\",\\\"DBInstanceType\\\":\\\"Master\\\",\\\"NodeId\\\":\\\"rn-t2****\\\",\\\"NodeType\\\":\\\"Primary\\\",\\\"Weight\\\":0}, {\\\"Availability\\\":\\\"Available\\\",\\\"DBInstanceId\\\":\\\"rm-2z****\\\",\\\"DBInstanceType\\\":\\\"Master\\\",\\\"NodeId\\\":\\\"rn-z9****\\\",\\\"NodeType\\\":\\\"Secondary\\\",\\\"Weight\\\":400}, {\\\"Availability\\\":\\\"Available\\\",,\\\"DBInstanceId\\\":\\\"rm-2z****\\\",\\\"DBInstanceType\\\":\\\"Master\\\",\\\"NodeId\\\":\\\"rn-1c****\\\",\\\"NodeType\\\":\\\"Secondary\\\",\\\"Weight\\\":400}]]",
  "ReadOnlyInstanceDistributionType": "Standard",
  "ReadOnlyInstanceMaxDelayTime": "30",
  "DbProxyEndpointReadWriteMode": "ReadWrite",
  "DbProxyEndpointAliases": "proxyterminal-test",
  "DBProxyEndpointId": "keaxncrjluwu0gue****",
  "DBProxyConnectStringPort": "3306",
  "DBProxyConnectString": "testproxy****.rwlb.rds.aliyuncs.com",
  "DBProxyEngineType": "normal",
  "EndpointConnectItems": {
    "EndpointConnectItems": [
      {
        "DbProxyEndpointPort": "3306",
        "DbProxyEndpointConnectString": "testproxy****.rwlb.rds.aliyuncs.com",
        "DbProxyEndpointNetType": "2"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400MaxscaleNotSupportCurrent custins can not support Maxscale.-
400InvalidEndPoint.FormatThe specified EndPoint is not valid.独享代理连接地址ID(DBProxyEndpointId)未传,查询不存在, 请检查Endpoint参数。
400InvalidDBInstanceNameSpecified parameter DBInstanceName is not valid.指定的实例名称(DBInstanceName)无效,请检查参数值是否为null或空字符串。
400Endpoint.NotFoundThe specified EndPoint is not valid.指定的代理终端不存在
400InvalidParameterSpecified parameter is invalid.-
403IncorrectKindCodeThe current KindCode of the custins does not support the operation.操作失败,当前实例所属环境类型不支持,请检查接口支持的实例类型。
403IncorrectDBInstanceTypeThe current database instance type does not support the operation.当前数据库实例类型不支持此操作。
404Endpoint.NotFoundSpecified endpoint is not found.未找到指定独享代理连接地址的端口。

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

变更历史

变更时间变更内容概要操作
2022-09-01OpenAPI 错误码发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    错误码 400 变更
    删除错误码:403
    删除错误码:404
2022-06-08OpenAPI 错误码发生变更,OpenAPI 入参发生变更,OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:DBProxyEngineType
出参OpenAPI 返回结构发生变更
阿里云首页 云数据库 RDS 相关技术圈