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

RDS提供数据库独享代理服务,包括读写分离、短连接优化等能力。详情请参见数据库独享代理

调用该接口时,需要实例为如下版本:

  • MySQL 8.0三节点企业版(内核小版本20191204或以上)
  • MySQL 8.0高可用版(内核小版本20190915或以上)
  • MySQL 5.7三节点企业版(内核小版本20191128或以上)
  • MySQL 5.7高可用版(内核小版本20190925或以上)
  • MySQL 5.6高可用版(内核小版本20200229或以上)

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeDBProxyEndpoint

系统规定参数,取值:DescribeDBProxyEndpoint

DBInstanceId String rm-bp1ja4f56s7us****

实例ID。

RegionId String cn-hangzhou

地域ID,可以通过接口DescribeRegions查看地域ID。

DBProxyEndpointId String keaxncrjluwu0gue****

代理终端名称。

DBProxyConnectString String testproxy****.rwlb.rds.aliyuncs.com

代理连接地址。

返回数据

名称 类型 示例值 描述
DBProxyConnectString String testproxy****.rwlb.rds.aliyuncs.com

代理连接地址。

DBProxyConnectStringNetType String InnerString

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

  • InnerString:内网地址。
  • OuterString:外网地址。
DBProxyConnectStringPort String 3306

代理连接地址端口。

DBProxyEndpointId String keaxncrjluwu0gue****

代理连接地址ID。可以通过本接口查询。

DBProxyFeatures String TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1

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

  • TransactionReadSqlRouteOptimizeStatus:事务拆分设置,取值为0(关闭)或1(开启)。
  • ConnectionPersist:连接池设置:取值为0(关闭)、1(会话级连接池)或2(事务级连接池)。
  • ReadWriteSpliting:读写分离设置,取值为0(关闭)或1(开启)。
DbProxyEndpointAliases String proxyterminal-test

代理终端的备注信息。

DbProxyEndpointReadWriteMode String ReadWrite

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

  • ReadWrite:读写模式。
  • ReadOnly:只读模式。
EndpointConnectItems Array of EndpointConnectItems

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

EndpointConnectItems
DbProxyEndpointConnectString String testproxy****.rwlb.rds.aliyuncs.com

代理连接地址。

DbProxyEndpointNetType String 2

网络类型,取值:

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

服务端口,默认为3306

ReadOnlyInstanceDistributionType String Standard

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

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

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

ReadOnlyInstanceWeight String [{\"Availability\":\"Available\",\"DBInstanceId\":\"rr-bp176984qewd8****\",\"DBInstanceType\":\"ReadOnly\",\"Weight\":400},{\"Availability\":\"Available\",\"DBInstanceId\":\"rm-bp1ja4f56s7us****\",\"DBInstanceType\":\"Master\",\"Weight\":0}]

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

  • DBInstanceId:实例ID。
  • DBInstanceType:实例类型,取值为Master(主实例)或ReadOnly(只读实例)。
  • Weight:读请求权重,以100递增,最大值为10000
说明 如果该实例下没有只读实例,本参数返回 null
RequestId String 847BA085-B377-4BFA-8267-F82345ECE1D2

请求ID。

示例

请求示例

http(s)://rds.aliyuncs.com/?Action=DescribeDBProxyEndpoint
&DBInstanceId=rm-bp1ja4f56s7us****
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

XML格式

<DescribeDBProxyEndpointResponse>
      <DbProxyEndpointReadWriteMode>ReadWrite</DbProxyEndpointReadWriteMode>
      <ReadOnlyInstanceDistributionType>Standard</ReadOnlyInstanceDistributionType>
      <DBProxyConnectString>testproxy****.rwlb.rds.aliyuncs.com</DBProxyConnectString>
      <RequestId>336E33D5-8C02-4265-9627-704BF9F3954B</RequestId>
      <DBProxyEndpointId>keaxncrjluwu0guehzae</DBProxyEndpointId>
      <DbProxyEndpointAliases>proxyterminal-test</DbProxyEndpointAliases>
      <DBProxyFeatures>TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1;PinPreparedStmt:0</DBProxyFeatures>
      <ReadOnlyInstanceWeight>[{"Availability":"Available","DBInstanceId":"rr-bp176984qewd8****","DBInstanceType":"ReadOnly","Weight":400},{"Availability":"Available","DBInstanceId":"rm-bp1ja4f56s7us****","DBInstanceType":"Master","Weight":0}]</ReadOnlyInstanceWeight>
      <ReadOnlyInstanceMaxDelayTime>30</ReadOnlyInstanceMaxDelayTime>
      <DBProxyConnectStringNetType>InnerString</DBProxyConnectStringNetType>
      <EndpointConnectItems>
            <EndpointConnectItems>
                  <DbProxyEndpointNetType>2</DbProxyEndpointNetType>
                  <DbProxyEndpointPort>3306</DbProxyEndpointPort>
                  <DbProxyEndpointConnectString>testproxy****.rwlb.rds.aliyuncs.com</DbProxyEndpointConnectString>
            </EndpointConnectItems>
            <EndpointConnectItems>
                  <DbProxyEndpointNetType>0</DbProxyEndpointNetType>
                  <DbProxyEndpointPort>3306</DbProxyEndpointPort>
                  <DbProxyEndpointConnectString>test****.rwlb.rds.aliyuncs.com</DbProxyEndpointConnectString>
            </EndpointConnectItems>
      </EndpointConnectItems>
      <DBProxyConnectStringPort>3306</DBProxyConnectStringPort>
</DescribeDBProxyEndpointResponse>

JSON格式

{
	"DbProxyEndpointReadWriteMode": "ReadWrite",
	"ReadOnlyInstanceDistributionType": "Standard",
	"DBProxyConnectString": "testproxy****.rwlb.rds.aliyuncs.com",
	"RequestId": "336E33D5-8C02-4265-9627-704BF9F3954B",
	"DBProxyEndpointId": "keaxncrjluwu0guehzae",
	"DbProxyEndpointAliases": "proxyterminal-test",
	"DBProxyFeatures": "TransactionReadSqlRouteOptimizeStatus:1;ConnectionPersist:0;ReadWriteSpliting:1;PinPreparedStmt:0",
	"ReadOnlyInstanceWeight": "[{\"Availability\":\"Available\",\"DBInstanceId\":\"rr-bp176984qewd8****\",\"DBInstanceType\":\"ReadOnly\",\"Weight\":400},{\"Availability\":\"Available\",\"DBInstanceId\":\"rm-bp1ja4f56s7us****\",\"DBInstanceType\":\"Master\",\"Weight\":0}]",
	"ReadOnlyInstanceMaxDelayTime": "30",
	"DBProxyConnectStringNetType": "InnerString",
	"EndpointConnectItems": {
		"EndpointConnectItems": [
			{
				"DbProxyEndpointNetType": "2",
				"DbProxyEndpointPort": "3306",
				"DbProxyEndpointConnectString": "testproxy****.rwlb.rds.aliyuncs.com"
			},
			{
				"DbProxyEndpointNetType": "0",
				"DbProxyEndpointPort": "3306",
				"DbProxyEndpointConnectString": "test****.rwlb.rds.aliyuncs.com"
			}
		]
	},
	"DBProxyConnectStringPort": "3306"
}

错误码

HttpCode 错误码 错误信息 描述
404 Endpoint.NotFound Specified endpoint is not found. 找不到指定的终结点
400 InvalidEndPoint.Format The specified EndPoint is not valid. 当前参数endpoint 是无效的或者不存在, 请检查endpoint参数
403 IncorrectKindCode The current KindCode of the custins does not support the operation. 当前实例所属环境类型 不支持此操作,请检查接口支持的实例类型!
403 IncorrectDBInstanceType The current database instance type does not support the operation. 当前数据库实例类型不支持此操作

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