调用 ModifyDBEndpoint 接口修改 Endpoint。

请求类型

异步请求。

注意事项

仅支持修改自定义终端。

自定义直连终端仅支持修改终端名称和终端描述。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mysql-e26822cf****	实例 ID。
EndpointId	String	是	mysql-e26822cf****-cluster	实例连接终端 ID。
ReadWriteMode	String	否	ReadOnly	连接终端的读写模式。取值： ReadWrite：读写。 ReadOnly：只读。说明该参数作为请求参数时，默认值为 ReadWrite。
EndpointName	String	否	终端名称	实例连接终端名称。终端名称的规则如下：不能以数字、中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度需要在 1~64 个字符内。
Description	String	否	终端描述	终端描述。长度需要在 1~255 个字符之内。
Nodes	String	否	Primary,mysql-e26822cf****-r90ab	连接终端配置的节点列表。说明主节点无需传节点 ID，传入 Primary 字符串即可。双节点实例代理终端在读写模式下可只关联主节点，也可以关联主节点和最多 10 个只读节点；在只读模式下只能关联只读节点，可关联最少 1 个、最多 10 个只读节点。直连终端在读写模式下只能关联主节点，在只读模式下只能关联 1 个只读节点。多节点实例默认终端关联了实例的所有节点，写终端仅关联主节点，默认终端和写终端均不支持调整关联的节点。只读终端默认关联了实例的所有备节点，最少可只关联一个备节点，最多可关联实例的所有备节点。调整多节点实例只读终端关联的节点时，需要关闭关联所有备节点功能。备节点切主后将自动与只读终端取消关联。多节点实例只读终端关联的备节点被切换成主节点后，只读终端关联的备节点将减少一个。如果需要维持只读终端原有的备节点数量，需要手动添加新的备节点。建议为终端配置足够的备节点以应对业务流量。为确保只读模式下的高可用性，建议至少为只读终端关联两个备节点（多节点实例）或两个只读节点（双节点实例）。
AutoAddNewNodes	Boolean	否	true	当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值： true：自动加入。 false：不自动加入（默认）。说明多节点实例连接终端的自动添加新节点功能不支持调整。默认终端和只读终端的自动添加新节点功能默认开启，写终端的自动添加新节点功能默认关闭。单节点实例不支持该功能。
ReadWriteSpliting	Boolean	否	true	开启读写分离。取值： true：打开读写分离。 false：关闭读写分离（默认）。说明当 ReadWriteMode 取值为 ReadWrite 时支持设置；当 ReadWriteMode 为 ReadOnly 时不支持设置。此参数仅对默认终端生效。单节点实例不支持该功能。
ReadOnlyNodeMaxDelayTime	Integer	否	30	只读节点的最大延迟阈值，当只读节点延迟时间超过该值时，读取流量不发往该节点。取值范围是 1~3600，默认值为 30，单位为秒。说明读写类型的终端，且开通读写分离后支持设置此参数。
ReadOnlyNodeDistributionType	String	否	LoadSchedule	读权重分配模式。当开通读写分离设置为 true 时需要传入此参数。在 CreateDBEndpoint 和 ModifyDBEndpoint 接口中做请求参数时，取值范围如下： LoadSchedule：负载调度。 RoundRobinCustom：自定义权重的轮询调度。 RoundRobinAuto：自动分配权重的轮询调度。在 DescribeDBInstanceDetail 接口中做返回参数时，取值范围如下： Default：按规格权重自动分配。 Custom：自定义分配权重。 RoundRobin：轮询调度。 LoadSchedule：负载调度。 RoundRobinCustom：自定义权重的轮询调度。 RoundRobinAuto：自动分配权重的轮询调度。说明多节点实例仅支持取值为 RoundRobinAuto。单节点实例不支持该功能。 ConnectionMode 参数取值为 Proxy，此参数必填；取值为 Direct时，参数无效。
ReadOnlyNodeWeight	Array of NodeWeightObject	否	[ { "NodeType" : "Primary", "Weight" : 100 }, { "NodeId" : "mysql-e26822cf**-r84eb", "Weight" : 100 }, { "NodeId" : "mysql-e26822cf**-r90ab", "Weight" : 200 } ]	自定义读权重分配，即传入主节点和只读节点的读请求权重。以 100 递增，最大值为 10000。当 ReadOnlyNodeDistributionType 取值为 Custom 时，需要传入此参数。说明主节点需要传入 NodeType 为 Primary，只读节点需要传入 NodeID。权重不可全部设置为 0。
IdleConnectionReclaim	Boolean	否	true	是否开启空闲连接回收。 true：开启。 false：不开启（默认）。说明单节点实例不支持该功能。
ConnectionPoolType	String	否	Direct	代理终端的连接池类型。取值： Transaction：事务级连接池。默认值。 Direct：直连模式。说明单节点实例不支持该功能。 ConnectionMode 参数取值为 Proxy，此参数必填；取值为 Direct 时，参数无效。
MultiStatementsMode	String	否	Loose	代理终端的 Multi-Statements 模式。取值： Strict：Strict 模式。默认值。 Loose：Loose 模式。说明单节点实例不支持该功能。 ConnectionMode 参数取值为 Proxy，此参数必填；取值为 Direct时，参数无效。
OverloadProtection	Boolean	否	false	是否开启过载保护。取值： true：是。默认值。 false：否。说明仅代理终端支持过载保护功能。过载保护功能仅在连接终端的读写分离功能开启，且主节点非当前连接终端唯一节点时生效。单节点实例不支持该功能。
MasterProtectorTimeout	Integer	否	60	过载保护超时时间。取值范围为 60~7200 之间的整数，默认值为 60，单位为秒。说明仅代理终端支持过载保护功能。该配置仅在 OverloadProtection 取值为 true时生效。
MasterNodeRouting	Boolean	否	false	是否开启主节点路由。取值： true：是。 false：否。默认值。说明仅代理终端支持该设置。多节点实例与单节点实例不支持该功能。
ImplicitTransSplit	Boolean	否	false	是否开启事务分离。取值： true：是。 false：否。默认值。说明仅代理终端支持该设置。
ConnectAllSlaveNodes	Boolean	否	false	是否关联所有的备节点。取值： true：是。默认值。 false：否。说明仅多节点实例的只读终端支持该配置。仅在实例有两个或更多备节点时才能关闭此功能。
EnableConnectionPersistent	Boolean	否	false	是否开启连接终端的连接保持功能。取值： true：是。 false：否（默认）。说明仅代理终端支持该设置。
CustomRouteStrategy	Object of CustomRouteStrategy	否	请参见请求示例。	自定义路由转发规则
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

示例

请求示例

返回示例

错误码

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

云数据库 MySQL 版