调用 CreateDBEndpoint 接口创建连接终端（Endpoint）。

请求类型

异步请求。

注意事项

仅支持为双节点实例和多节点实例创建连接终端。多节点实例仅支持创建 3 个自定义读写直连终端。

调试

API Explorer

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

去调试

请求参数

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

NodeWeightObject

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

CustomRouteStrategy

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

KeywordRouteStrategy

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

返回参数

参数	类型	示例值	描述
InstanceId	String	mysql-3c25f219****	实例 ID。
EndpointId	String	mysql-3c25f219****-custom-eeb5	终端 ID。

示例

请求示例

返回示例

错误码

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

云数据库 MySQL 版