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

文档中心

立即注册

导航

CreateDBEndpoint

最近更新时间：2024.12.13 12:00:10首次发布时间：2023.11.15 22:39:52

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

请求类型

异步请求。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	postgres-21a3333b****	实例 ID。
EndpointType	String	是	Custom	连接终端类型，当前仅支持取值 `Custom`，即自定义类型。
ReadWriteMode	String	否	ReadOnly	读写模式： `ReadWrite`：读写。 `ReadOnly`：只读。默认值。
EndpointName	String	否	EndpointName	实例连接终端名称。不能以数字、中划线（-）开头。只能包含中文、字母、数字、下划线（_）和中划线（-）。长度需要在 1~64 个字符内。说明不传入时会自动将连接终端命名为“自定义终端”。
Nodes	String	否	Primary,postgres-ca7b7019****-rocbcb	连接终端配置的节点列表。说明当 `EndpointType` 为 `Custom` 时必选。主节点无需传节点 ID，传入 Primary 字符串即可。

返回参数

null

示例

请求示例

POST /?Action=CreateDBEndpoint&Version=2022-01-01 HTTP/1.1
Content-Type: application/json
Host: open.volcengineapi.com
X-Date: 20231002T101010Z
Authorization: HMAC-SHA256 Credential=AKLTN2I0MmFiNzMxNWE5NDgzMzk4MmVjMTVkODlkZTZ****/20211202/cn-beijing/rds_postgresql/request,SignedHeaders=x-date, Signature=71d31fc7bcf990142851c9833c5656391486cda0ae2e0b8ada733b7c6458****
{
    "InstanceId": "postgres-ca7b7019****",
    "EndpointName": "自定义终端",
    "EndpointType": "Custom",
    "Nodes": "postgres-ca7b7019****-rocbcb",
    "ReadWriteMode": "ReadOnly"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202308021119002CCE8C74AFEBB9023B8E",
        "Action": "CreateDBEndpoint",
        "Version": "2022-01-01",
        "Service": "rds_postgresql",
        "Region": "cn-beijing"
    },
    "Result": null
}