ModifyCustomEndpoint - 修改自定义端地址-云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

接口说明

在 PolarDB-X 中，除了默认的主地址（Primary Endpoint）和只读地址（Read-only Endpoint）外，用户还可以创建自定义地址（Custom Endpoint），用于实现更灵活的读写分离、负载均衡或业务隔离策略。ModifyCustomEndpoint 接口允许你动态调整这些自定义地址的属性，而无需重启实例。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

polardbx:ModifyCustomEndpoint

update

*PolarDBXInstance

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

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	实例所在地域。	cn-zhangjiakou
DBInstanceName	string	是	实例 Id	mydatabase
CustomEndpointId	string	是	用户端域名 id	cep-002
Name	string	否	名称。	secondary-endpoint
NodeIds	string	否	node ids	node3
NodeAutoEnter	boolean	否	节点在被添加或恢复后，是否自动加入集群并开始提供服务	true
NodeRole	string	否	节点作用。	master

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	1A586DCB-39A6-4050-81CC-C7BD4CCDB49F

示例

正常返回示例

JSON格式

{
  "RequestId": "1A586DCB-39A6-4050-81CC-C7BD4CCDB49F"
}

错误码

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

变更历史

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