CreateCustomEndpoint - 创建自定义终端-云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

接口说明

更多关于实例账号的信息，请参见账号管理。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

polardbx:CreateCustomEndpoint

create

*PolarDBXInstance

acs:polardbx:{#regionId}:{#accountId}:polardbxinstance/{#PolarDBXInstanceId}

无

请求参数

名称	类型	必填	描述	示例值
DBInstanceName	string	是	实例 Id	pxc-hzjasd****
Name	string	是	访问控制实例名称。名称长度为 2~128 个字符，以大小写字母或中文开头，可包含数字、下划线（_）和短划线（-）。	ext-win-live-17
VpcId	string	是	访问端点所在的专有网络 ID。	vpc-bp1ndoug37dtwoedlmru0
VSwitchId	string	是	虚拟交换机 ID。	vsw-*********
NodeIds	string	是	RemindUnit（对象类型）为 NODE（任务节点）时，监控的任务节点 ID。多个 ID 之间使用英文逗号（,）分隔，一个规则最多监控 50 个节点。	r-bp1l5kfgw8****c3iv
NodeAutoEnter	boolean	是	节点在被添加或恢复后，是否自动加入集群并开始提供服务	true
NodeRole	string	否	若希望查询云原生版读写分离架构实例中只读节点的指标，您在传入具体 NodeId 的同时，还需要在本参数传入 READONLY。说明其余情况请无需传入（或传入 MASTER）。	READONLY
RegionId	string	否	实例所在地域。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9
Data	object	返回数据。
CustomEndpointId	string	终端 ID	pxe-c4gkgqg****7sgyg
DBInstanceName	string	实例 Id	pxc-*********

示例

正常返回示例

JSON格式

{
  "RequestId": "2DFF784E-DC31-5BBC-9B25-9261CD9E0AA9",
  "Data": {
    "CustomEndpointId": "pxe-c4gkgqg****7sgyg",
    "DBInstanceName": "pxc-*********"
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	CustomEndpoint.ExceedLimit	the count of custom endpoints can not exceed limiting value.	自定义连接的数量超过限制

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。