CreateDBEndpoint--云数据库 veDB MySQL 版-火山引擎

文档中心

立即注册

导航

CreateDBEndpoint

最近更新时间：2024.11.08 10:14:36首次发布时间：2023.06.09 11:33:53

调用 CreateDBEndpoint 接口为指定 veDB MySQL 实例创建连接终端。

请求类型

同步请求。

调试

API Explorer

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

去调试

请求参数

名称	类型	是否必选	示例值	描述
InstanceId	String	是	vedbm-2pf2xk5v****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询实例 ID。
EndpointType	String	是	Custom	连接终端类型。取值固定为 `Custom`，表示自定义终端。
ReadWriteMode	String	否	ReadOnly	终端读写模式。取值： `ReadWrite`：读写终端。 `ReadOnly`：只读终端（默认）。
EndpointName	String	否	自定义终端	连接终端名称，设置规则如下：不能以数字或中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度为 1~64 个字符。
Description	String	否	这是对连接终端的描述	连接终端的描述信息。长度不能超过 200 个字符。
Nodes	String	是	vedbm-2pf2xk5v**-0,vedbm-2pf2xk5v**-1	连接终端关联的节点 ID，多个节点 ID 之间使用英文逗号（,）分隔。填写规则如下：当 `ReadWriteMode` 取值为 `ReadWrite` 时，至少需要传入两个节点，且必须传入主节点。当 `ReadWriteMode` 取值为 `ReadOnly` 时，可以传入一个或多个只读节点。说明您可以调用 DescribeDBInstanceDetail 接口，查询指定实例的详细信息，包括节点 ID。
AutoAddNewNodes	Boolean	否	true	设置后续新创建的只读节点是否自动加入该连接终端。取值： `true`：自动加入。 `false`：不自动加入（默认）。
MasterAcceptReadRequests	Boolean	否	true	主节点接受读请求。取值范围： `true`：（默认）当开启主节点接受读功能后，非事务读请求会按活跃请求数负载均衡的模式发送至主节点或只读节点。 `false`：当关闭主节点接受读功能后，此时主节点只接受事务读请求，而非事务读请求不会发往主节点。说明仅当 `ReadWriteMode` 取值为`ReadWrite` 时，支持开启主节点接受读。
DistributedTransaction	Boolean	否	true	设置是否开启事务拆分，关于事务拆分的详细介绍请参见事务拆分。取值范围： `true`：开启（默认）。 `false`：不开启。说明仅当 `ReadWriteMode` 取值为`ReadWrite` 时，支持开启事务拆分。
ConsistLevel	String	否	Session	一致性级别，关于一致性级别的详细介绍请参见一致性级别。取值范围： `Eventual`：最终一致性。 `Session`：会话一致性。 `Global`：全局一致性。说明当 `ReadWriteMode` 取值为 `ReadWrite` 时，可选择的一致性级别有 `Eventual`、`Session`（默认）、`Global`。当 `ReadWriteMode` 取值为 `ReadOnly` 时，一致性级别默认为 `Eventual`，且不可更改。
ConsistTimeout	Integer	否	10000	延迟很大时，只读节点同步最新数据的超时时间，单位为 us，取值范围为 1us~100000000us，默认值为 10000us。说明当 `ConsistLevel` 取值为 `Global` 或 `Session` 时，该参数才生效。
ConsistTimeoutAction	String	否	ReadMaster	只读节点同步数据超时后的超时策略，支持以下两种策略： `ReturnError`：返回 SQL 报错（`wait replication complete timeout, please retry`）。 `ReadMaster`：发送请求到主节点（默认）。说明当 `ConsistLevel` 取值为 `Global` 或 `Session` 时，该参数才生效。

返回参数

名称	类型	示例值	描述
EndpointId	String	vedbm-2pf2xk5v****-Custom-50yv	创建的连接终端的 ID。

请求示例

创建一个读写终端，关联主节点和只读节点 1，一致性级别采用会话一致性，并开启事务拆分、主节点接受读和自动加入新节点功能。

POST /?Action=CreateDBEndpoint&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: vedbm.volcengineapi.com
X-Date: 20230823T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkOD******/20230823/cn-beijing/vedbm/request,SignedHeaders=x-date, Signature=6a593bf5f59e7c1109fb205c739d1cff4c672fe2d251963f4d48c87******

{
    "InstanceId":"vedbm-iqnh3a7z****",
    "EndpointName":"自定义的读写终端",
    "EndpointType":"Custom",
    "Nodes":"vedbm-iqnh3a7z****-1,vedbm-iqnh3a7z****-0",
    "ReadWriteMode":"ReadWrite",
    "AutoAddNewNodes":true,
    "ConsistLevel":"Session",
    "DistributedTransaction":true,
    "MasterAcceptReadRequests":true,
    "ConsistTimeout":10000,
    "ConsistTimeoutAction":"ReadMaster"
}

创建一个只读终端，关联只读节点 1 和只读节点 2，并开启自动加入新节点功能。

{
    "InstanceId":"vedbm-cxj2z00l****",
    "EndpointName":"自定义只读终端",
    "EndpointType":"Custom",
    "Nodes":"vedbm-cxj2z00l****-1,vedbm-cxj2z00l****-2",
    "ReadWriteMode":"ReadOnly",
    "AutoAddNewNodes":true
}

返回示例

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230424195109B8E5E7E8FA0AC9583F6E",
        "Action": "CreateDBEndpoint",
        "Version": "2022-01-01",
        "Service": "vedbm",
        "Region": "cn-beijing-a"
    },
    "Result": {
        "EndpointId": "vedbm-2pf2xk5v****-Custom-50yv"
    }
}

错误码

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