调用 DescribeDBInstanceEndpoints 接口查询实例的连接地址列表。

请求类型

同步请求。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mysql-f83edc2e****	实例 ID。

返回参数

参数	类型	示例值	描述
Endpoints	Array of ConnectionInfoObject	请参见返回示例。	实例的连接信息

ConnectionInfoObject

参数	类型	示例值	描述
Addresses	Array of AddressObject	请参见返回示例。	地址列表。
AutoAddNewNodes	String	Enable	当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值： Enable：自动加入 Disable：不自动加入（默认）。
ConnectionInfoTags	Array of String	["Default"]	连接终端标签。
ConnectionMode	String	Proxy	连接终端类型。取值： Proxy：代理终端。 Direct：直连终端。说明如实例的数据库代理功能已开启，可以取值为 Proxy 或 Direct。如实例的数据库代理功能未开启，仅可以取值为 Direct。可调用 DescribeDBInstanceDetail 接口查询实例数据库代理功能的开启状态。
CustomRouteStrategy	Object of CustomRouteStrategy	请参见返回示例。	连接终端的自定义路由转发规则。
ConnectionPoolType	String	Direct	代理终端的连接池类型。取值： Transaction：事务级连接池。默认值。 Direct：直连模式。
Description	String	这是一段连接终端的描述信息。	连接终端的描述信息。
EnableReadOnly	String	Enable	是否已开启全局只读，取值： Enable：开启。 Disable：未开启。
EnableReadWriteSplitting	String	Enable	是否已开启读写分离，取值： Enable：开启。 Disable：未开启。
EnableConnectionPersistent	Boolean	false	是否启用连接保持。取值： true：是。 false：否。
EndpointId	String	mysql-050b3e08****	实例连接终端 ID。
EndpointName	String	自定义连接终端	实例连接终端名称。
EndpointType	String	Custom	终端类型。取值为 Custom，自定义终端。
IdleConnectionReclaim	Boolean	true	空闲连接回收功能是否开启。 true：开启。 false：不开启。说明仅代理终端会返回该字段。
ImplicitTransSplit	Boolean	false	是否开启事务分离。取值： true：是。 false：否。说明仅代理终端会返回该字段。
MasterNodeRouting	Boolean	false	是否开启主节点路由。取值： true：是。 false：否。说明仅代理终端会返回该字段。
MasterProtectorTimeout	Integer	60	过载保护超时时间。取值范围为 60~7200 之间的整数，单位为秒。说明仅代理终端会返回该字段。
MultiStatementsMode	String	Loose	代理终端的 Multi-Statements 模式。取值： Strict：Strict 模式。默认值。 Loose：Loose 模式。
OverloadProtection	Boolean	false	是否开启过载保护。取值： true：是。 false：否。说明仅代理终端会返回该字段。
ReadOnlyNodeDistributionType	String	LoadSchedule	读权重分配模式。当开通读写分离设置为 true 时需要传入此参数。在 CreateDBEndpoint 和 ModifyDBEndpoint 接口中做请求参数时，取值范围如下： LoadSchedule：负载调度。 RoundRobinCustom：自定义权重的轮询调度。 RoundRobinAuto：自动分配权重的轮询调度。在 DescribeDBInstanceDetail 接口中做返回参数时，取值范围如下： Default：按规格权重自动分配。 Custom：自定义分配权重。 RoundRobin：轮询调度。 LoadSchedule：负载调度。 RoundRobinCustom：自定义权重的轮询调度。 RoundRobinAuto：自动分配权重的轮询调度。
ReadOnlyNodeMaxDelayTime	Integer	40	只读节点延迟阈值。取值范围为 1~3600，默认为 30，单位为秒。
ReadOnlyNodeWeight	Array of NodeWeightObject	请参见返回示例。	连接终端配置的节点列表及对应的只读权重。
ReadWriteMode	String	ReadOnly	读写模式： ReadWrite：读写。 ReadOnly：只读。

AddressObject

参数	类型	示例值	描述
DNSVisibility	Boolean	false	false：火山引擎私网解析（默认）。 true：火山引擎私网以及公网解析。
Domain	String	mysql1d797b6f****.rds.ivolces.com	连接域名。
EipId	String	eip-13g6t81tglmgw3n6nu4vt****	EIP 的 ID，仅对 Public 地址有效。
IPAddress	String	10...3	IP 地址。
InternetProtocol	String	IPv4	IP 协议版本。取值为 IPv4。
NetworkType	String	Private	网络地址类型，取值为： Private：私网地址。 Public：公网地址。
Port	String	3306	端口。
SubnetId	String	subnet-2bzr8zdx5o8ao2dx0efq4****	子网 ID，仅对 Private 地址有效。
EipLocked	Boolean	false	连接终端使用的 EIP 是否因欠费关停。取值： true：是。 false：否。

CustomRouteStrategy

参数	类型	示例值	描述
KeywordRouteStrategy	Array of KeywordRouteStrategy	请参见示例。	自定义路由策略。

KeywordRouteStrategy

参数	类型	示例值	描述
NodeType	String	Primary	SQL 转发规则的转发目标。取值： Primary：主节点。 Secondary：备节点。 ReadOnly：只读节点。说明如实例为双节点实例，可选择主节点或只读节点。如实例为多节点实例，可选择主节点或备节点。
SQLKeyword	String	Select	转发规则的关键字。SQL 关键字的设置规则如下：单个规则最多可包含 20 个关键字。最大长度为 64 个字符，可包含英文字母、数字、下划线 _、@、#、:= 和中文字符。

NodeWeightObject

参数	类型	示例值	描述
NodeId	String	mysql-050b3e08****-2	只读节点需要传入 NodeId，主节点无需传入。
NodeType	String	Primary	节点类型。 Primary：主节点。 ReadOnly：只读节点。
Weight	Integer	100	节点的读权重，以 100 递增，最大值为 10000。说明权重不可全部设置为 0。

示例

请求示例

返回示例

错误码

更多详情，请参见错误码。

云数据库 MySQL 版