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

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

调用该接口时，实例必须为MySQL 8.0高可用版（本地SSD盘）。

调试

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

请求参数

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

系统规定参数，取值：DescribeDBProxyEndpoint。

DBInstanceId String 是 rm-t4n3axxxxx

实例ID。
RegionId String 是 cn-hangzhou

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

DBProxyEndpointId String 否 ta9um4xxxxx

代理连接地址ID。
DBProxyConnectString String 否 ta9umxxxxx.rwlb.singapore.rds.aliyuncs.com

代理连接地址。
AccessKeyId String 否 LTAIfCxxxxxxx

阿里云颁发给用户的访问服务所用的密钥ID。

返回数据

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

代理连接地址。
DBProxyConnectStringNetType String InnerString

代理连接地址的网络类型，取值：

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

代理连接地址端口。
DBProxyEndpointId String ta9um4xxxxx

代理连接地址ID。可以通过本接口查询。
DBProxyFeatures String ReadWriteSpliting:1;ConnectionPersist:0;

代理连接地址上开通的独享代理功能列表及开通情况，各功能之间以英文分号（;）隔开。格式：功能1:开通情况1;功能2:开通情况2;...

功能取值：

  • ReadWriteSpliting：读写分离；
  • ConnectionPersist：短连接优化。

开通情况取值：

  • 1：功能已开通；
  • 0：功能未开通。
ReadOnlyInstanceDistributionType String Standard

读权重分配模式，详情请参见读权重分配。取值：

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

读写分离的延迟阈值，当只读实例延迟时间超过该阈值时，读取流量不发往该实例，单位：秒。
ReadOnlyInstanceWeight String {“rm-uf6wjk5xxxx“:”500”,”rr-tfhfgk5xxx”:”200”...}

自定义读权重分配，即传入主实例和只读实例的读请求权重。以100递增，最大值为10000，格式：{“实例1ID“:”权重”,”实例2ID”:”权重”...}。

说明 仅当ReadOnlyInstanceDistributionType=Custom时，需要传入此参数。
RequestId String 847BA085-B377-4BFA-8267-F82345ECE1D2

请求ID。

示例

请求示例


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

正常返回示例

XML 格式 

<DescribeDBProxyEndpointResponse>
  <DBProxyEndpointId>ta9umxxxxx</DBProxyEndpointId>
	  <ReadOnlyInstanceWeight>""</ReadOnlyInstanceWeight>
	  <ReadOnlyInstanceMaxDelayTime>30</ReadOnlyInstanceMaxDelayTime>
	  <DBProxyConnectString>ta9umxxxxx.rwlb.singapore.rds.aliyuncs.com</DBProxyConnectString>
	  <DBProxyConnectStringNetType>InnerString</DBProxyConnectStringNetType>
	  <RequestId>847BA085-B377-4BFA-8267-F82345ECE1D2</RequestId>
	  <DBProxyFeatures>ReadWriteSpliting:0;ConnectionPersist:0</DBProxyFeatures>
	  <DBProxyConnectStringPort>3306</DBProxyConnectStringPort>
	  <ReadOnlyInstanceDistributionType>Standard</ReadOnlyInstanceDistributionType>
</DescribeDBProxyEndpointResponse>

JSON 格式 

{
	"ReadOnlyInstanceWeight":"\"\"",
	"DBProxyEndpointId":"ta9umxxxxx",
	"ReadOnlyInstanceMaxDelayTime":"30",
	"DBProxyConnectStringNetType":"InnerString",
	"DBProxyConnectString":"ta9umxxxxx.rwlb.singapore.rds.aliyuncs.com",
	"RequestId":"847BA085-B377-4BFA-8267-F82345ECE1D2",
	"DBProxyFeatures":"ReadWriteSpliting:0;ConnectionPersist:0",
	"DBProxyConnectStringPort":"3306",
	"ReadOnlyInstanceDistributionType":"Standard"
}

错误码

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