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

文档中心

立即注册

导航

CreateDBEndpoint

最近更新时间：2024.11.05 16:00:06首次发布时间：2023.02.02 17:41:21

调用 CreateDBEndpoint 接口创建 Endpoint。

请求类型

异步请求。

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	mysql-e26822cf****	实例 ID。
EndpointType	String	是	Custom	连接终端类型。取值为 `Custom`，自定义终端。
ReadWriteMode	String	否	ReadOnly	读写模式： `ReadWrite`：读写。 `ReadOnly`：只读（默认）。
EndpointName	String	否	EndpointName	实例连接终端名称。不能以数字、中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度需要在1~64个字符内。
Description	String	否	备注	备注。
Nodes	String	否	Primary,mysql-3c25f219****-r5b3f	连接终端配置的节点 ID 列表。当 EndpointType 为 Custom 时必选。说明如需将主节点加入终端，不需填写主节点 ID，只需填写 Primary。多个节点 ID 之间用英文逗号（,）分隔。
AutoAddNewNodes	Boolean	否	true	当终端类型为读写终端或只读终端时，支持设置新节点是否自动加入。取值： `true`：自动加入。 `false`：不自动加入（默认）。

返回参数

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

示例

请求示例

POST /?Action=CreateDBEndpoint&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=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "InstanceId": "mysql-3c25f219****",
    "EndpointName": "自定义终端",
    "EndpointType": "Custom",
    "Nodes": "Primary",
    "ReadWriteMode": "ReadWrite",
    "AutoAddNewNodes": true
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230302225000051F23B8DD57341993BE",
        "Action": "CreateDBEndpoint",
        "Version": "2022-01-01",
        "Service": "rds_mysql",
        "Region": "cn-beijing"
    },
    "Result": {
        "EndpointId": "mysql-f23648f2****-custom-eeb5",
        "InstanceId": "mysql-f23648f2****"
    }
}

错误码

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