You need to enable JavaScript to run this app.
导航
ModifyDBEndpoint
最近更新时间:2025.06.26 21:06:15首次发布时间:2023.02.02 17:41:21
我的收藏
有用
有用
无用
无用

调用 ModifyDBEndpoint 接口修改 Endpoint。

请求类型

异步请求。

调试

请求参数

参数
类型
是否必选
示例值
描述
InstanceId
String
mysql-e26822cf****
实例 ID。
EndpointId
String
mysql-e26822cf****-cluster
实例连接终端 ID。
ReadWriteMode
String
ReadOnly

连接终端的读写模式。取值:

  • ReadWrite:读写。
  • ReadOnly:只读。

说明

该参数作为请求参数时,默认值为 ReadWrite

EndpointName
String
终端名称

实例连接终端名称。终端名称的规则如下:

  • 不能以数字、中划线(-)开头。
  • 只能包含中文、字母、数字、下划线(_)和中划线(-)。
  • 长度需要在 1~64 个字符内。
Description
String
终端描述
终端描述。
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

ReadOnlyNodeWeight
Object[]
[ { "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:直连模式。
MultiStatementsMode
String
Loose

代理终端的 Multi-Statements 模式。取值:

  • Strict:Strict 模式。默认值。
  • Loose:Loose 模式。
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:否。

说明

  • 仅多节点实例的只读终端支持该配置。
  • 仅在实例有两个或更多备节点时才能关闭此功能。
ConnectionMode
String
Proxy

连接终端类型。取值:

  • Proxy:代理终端。
  • Direct:直连终端。

说明

  • 可调用 DescribeDBInstanceDetail 接口查询实例数据库代理功能的开启状态。
    • 如实例的数据库代理功能已开启,可以取值为 ProxyDirect
    • 如实例的数据库代理功能未开启,仅可以取值为 Direct
  • 不支持调整多节点实例连接终端的类型。

返回参数

null

示例

请求示例

POST /?Action=ModifyDBEndpoint&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds-mysql.cn-beijing.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "InstanceId": "mysql-3c25f219bdbf",
    "EndpointId": "mysql-3c25f219bdbf-custom-e020",
    "EndpointName": "自定义终端",
    "Nodes": "Primary,mysql-e26822cf****-r90ab",
    "AutoAddNewNodes": true,
    "ReadOnlyNodeDistributionType": "Default",
    "ReadWriteMode": "ReadWrite",
    "ReadOnlyNodeMaxDelayTime": 30
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230111155941DE19D8CD8EB9198A3133",
        "Action": "ModifyDBEndpoint",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": null
}

错误码

更多详情,请参见错误码