You need to enable JavaScript to run this app.
导航
云数据库 MySQL 版
  • 文档首页
    • /
  • 云数据库 MySQL 版

ModifyDBEndpoint

最近更新时间：2023.11.21 20:54:02

首次发布时间：2023.02.02 17:41:21

我的收藏

调用 ModifyDBEndpoint 接口修改 Endpoint。

请求类型

异步请求。

请求参数

名称类型是否必选示例值描述
InstanceIdString是rds-mysql-h441603c****实例 ID。
EndpointIdString是rds-mysql-h441603c****实例连接终端 ID。

ReadWriteMode

String

否

ReadOnly

读写模式：

  • ReadWrite：读写。
  • ReadOnly：只读（默认）。

EndpointName

String

否

终端名称

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

  • 不能以数字、中划线（-）开头。
  • 只能包含中文、字母、数字、下划线（_）和中划线（-）。
  • 长度需要在 1~64 个字符内。
DescriptionString否终端描述终端描述。

Nodes

String

否

Primary,rds-***************

连接终端配置的节点列表。

说明

主节点无需传节点 ID，传入 Primary 字符串即可。

AutoAddNewNodes

Boolean

否

TRUE

当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值：

  • TRUE - 自动加入。
  • FALSE - 不自动加入（默认）。

ReadWriteSpliting

Boolean

否

TRUE

开通读写分离。取值：TRUE、FALSE。
当 ReadWriteMode 为读写时支持设置；当 ReadWriteMode 为只读时不支持设置。此参数仅对默认终端生效。

ReadOnlyNodeMaxDelayTime

Integer

否

30

只读节点的最大延迟阈值，当只读节点延迟时间超过该值时，读取流量不发往该节点，单位：秒。取值：0~3600。默认值：30。

说明

读写类型的终端，且开通读写分离后支持设置此参数。

ReadOnlyNodeDistributionType

String

否

Default

读权重分配模式。当开通读写分离设置为 TRUE 时需要传入此参数。取值：

  • Default：按规格权重自动分配（默认）。
  • Custom：自定义分配权重。

ReadOnlyNodeWeight

Array of NodeWeightObject

否

[
{
"NodeType" : "Primary",
"Weight" : 100
},
{
"NodeId" : "rds-mysql-ro441603c81b7a-2",
"Weight" : 100
},
{
"NodeId" : "rds-mysql-ro441603c81b7a-3",
"Weight" : 200
}
]

自定义读权重分配，即传入主节点和只读节点的读请求权重。以 100 递增，最大值为 10000。当 ReadOnlyNodeDistributionType 取值为 Custom 时，需要传入此参数。更多关于 NodeWeightObject 的信息，请参见数据结构。

说明

  • 主节点需要传入 NodeType 为 Primary，只读节点需要传入 NodeID。
  • 权重不可全部设置为 0。

返回参数

null

请求示例

POST /?Action=ModifyDBEndpoint&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: rds.volcengineapi.com
X-Date: 20211202T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_mysql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c645a****

{
    "InstanceId": "mysql-3c25f219bdbf",
    "EndpointId": "mysql-3c25f219bdbf-custom-e020",
    "EndpointName": "自定义终端",
    "Nodes": "Primary",
    "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
}

错误码

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