调用 ModifyDBEndpointConnectionMode 接口修改连接终端的类型。

请求类型

异步请求。

注意事项

仅在实例的数据库代理服务开启时支持切换终端的类型。

仅双节点实例支持调整连接终端的类型。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mysql-25651c34****	实例 ID。
EndpointId	String	是	mysql-25651c34****-cluster	连接终端 ID。
ConnectionMode	String	是	Proxy	终端的连接模式。取值： Proxy：代理终端（默认）。 Direct：直连终端。说明可调用 DescribeDBInstanceDetail 接口查询实例数据库代理功能的开启状态。如实例的数据库代理功能已开启，可以取值为 Proxy 或 Direct。如实例的数据库代理功能未开启，仅可以取值为 Direct。不支持调整多节点实例连接终端的类型。
CreateDBEndpointReq	Object of CreateDBEndpointReq	是	请参见请求示例。	连接终端转换后的配置。

CreateDBEndpointReq

参数	类型	是否必选	示例值	描述
EndpointType	String	是	Custom	连接终端类型。取值: Custom：自定义终端。 Cluster：默认终端。
InstanceId	String	是	mysql-e26822cf****	实例 ID。
Nodes	String	是	Primary	连接终端关联的节点 ID 列表。说明如需将主节点加入终端，不需填写主节点 ID，只需填写 Primary。多个节点 ID 之间用英文逗号（,）分隔。直连终端只能关联一个节点。
Description	String	否	这是一段连接终端的备注信息。	备注。
EndpointName	String	否	TestEndpoint	实例连接终端名称。不能以数字、中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度需要在1~64个字符内。说明如不设定，则不修改终端名称。
ConnectionPoolType	String	否	Direct	转换为代理终端时，设置终端的连接池类型。取值： Transaction：事务级连接池。默认值。 Direct：直连模式。
IdleConnectionReclaim	Boolean	否	true	转换为代理终端时，设置是否开启终端的空闲连接回收功能。取值： true：是。 false：否。默认值。
AutoAddNewNodes	Boolean	否	false	转换为代理终端时，设置新节点是否自动加入终端。取值： true：自动加入。默认值。 false：不自动加入。
ReadWriteMode	String	否	ReadWrite	连接终端的读写模式。取值： ReadWrite：读写。 ReadOnly：只读。说明该参数作为请求参数时，默认值为 ReadWrite。该参数仅在 EndpointType 取值为 Custom时生效。
ReadWriteSpliting	Boolean	否	false	转换为代理终端时，设置是否开启终端的读写分离功能。取值： true：是。默认值。 false：否。
MultiStatementsMode	String	否	Loose	转换为代理终端时，设置终端的 Multi-Statements 模式。取值： Strict：Strict 模式。默认值。 Loose：Loose 模式。
OverloadProtection	Boolean	否	false	转换为代理终端时，设置是否开启终端的过载保护功能。取值： true：是。默认值。 false：否。
MasterProtectorTimeout	Integer	否	100	转换为代理终端时，设置终端的过载保护超时时间。取值范围为 60~7200 之间的整数，默认值为 60，单位为秒。
ReadOnlyNodeDistributionType	String	否	RoundRobinCustom	转换为代理终端时，设置终端的读权重分配模式。当开通读写分离设置为 true 时需要传入此参数。在 CreateDBEndpoint 和 ModifyDBEndpoint 接口中做请求参数时，取值范围如下： LoadSchedule：负载调度。 RoundRobinCustom：自定义权重的轮询调度。 RoundRobinAuto：自动分配权重的轮询调度。在 DescribeDBInstanceDetail 接口中做返回参数时，取值范围如下： Default：按规格权重自动分配。 Custom：自定义分配权重。 RoundRobin：轮询调度。 LoadSchedule：负载调度。 RoundRobinCustom：自定义权重的轮询调度。 RoundRobinAuto：自动分配权重的轮询调度。
ReadOnlyNodeWeight	Array of NodeWeightObject	否	请参见请求示例。	转换为代理终端时，自定义终端的读权重分配策略。
MasterNodeRouting	Boolean	否	true	是否开启主节点路由。取值： true：是。 false：否。默认值。说明仅代理终端支持该设置。
ReadOnlyNodeMaxDelayTime	Integer	否	40	只读节点延迟阈值。取值范围为 1~3600，默认为 30，单位为秒。
ImplicitTransSplit	Boolean	否	false	转换为代理终端时，设置是否开启终端的事务分离功能。取值： true：是。 false：否。默认值。
CustomRouteStrategy	Object of CustomRouteStrategy	否	请参见请求示例。	连接终端的 SQL 转发规则。
ConsistentReadConfig	Object of ConsistentReadConfig	否	请参见请求示例。	设置一致性级别。

NodeWeightObject

参数	类型	是否必选	示例值	描述
NodeId	String	否	mysql-050b3e08****-2	只读节点需要传入 NodeId，主节点无需传入。
NodeType	String	否	Primary	节点类型。 Primary：主节点。 ReadOnly：只读节点。
Weight	Integer	否	100	节点的读权重。步长为 100，取值范围为 [0~10000]。说明单个节点的读权重允许设置为 0，但所有节点的读权重总和必须大于或等于 100。

CustomRouteStrategy

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

KeywordRouteStrategy

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

ConsistentReadConfig

参数	类型	是否必选	示例值	描述
EnableConsistentRead	Boolean	否	true	是否开启一致性读。取值如下： true：开启。 false：不开启。
ConsistentReadMode	String	否	Session	一致性读级别。 Eventual （默认值）：最终一致性。 Session：会话一致性。 Global：全局一致性。
ConsistentReadTimeoutMs	Long	否	20	一致性读等待超时时间。默认值为10 ms。取值范围为 0～60000，单位为 ms （毫秒）。取值为 0 时，表示不等待。
ConsistentReadTimeoutAction	String	否	TransMaster	设置只读节点在超时时间内仍未追平目标位点时，代理处理读请求的方法。取值如下： TransMaster （默认值）：转发至主节点。 Error：返回错误。

返回参数

null

示例

请求示例 1

连接终端转换为直连终端

返回示例 1

请求示例 2

直连终端转为代理终端

返回示例 2

错误码

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

云数据库 MySQL 版