DescribeCustomEndpointList - 查询自用户定义域名列表 - 云原生数据库 PolarDB

查询自用户定义域名列表

接口说明

该接口用于获取用户已配置的自定义终端节点（Endpoint）列表，便于管理和查看私有连接或 VPC 终端服务的设置。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

polardbx:DescribeCustomEndpointList

list

*PolarDBXInstance

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

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	实例所在地域。	cn-hangzhou
DBInstanceName	string	是	实例名称	pxc-xxx
CustomEndpointIds	string	否	自定义域名 ID	pxe-b6e****no4pfap1s
CheckDeleteCN	boolean	否	查询 CN 是否被删除	true

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	6352AC16-76BF-5135-B1EA-ED49293526E6
Data	object	数据结构体。
CanDeleteCount	integer	是否是可删除节点。	0
Endpoints	array<object>	Endpoint 详细信息。
	object	Endpoint 详细信息。
CustomEndpointId	string	用户端域名 id。	pxe-b6e****o4pfap1s
Name	string	名称。	Name
DBInstanceName	string	实例 ID。	pxc-hz****zoxherr7
ConnectionString	string	实例连接地址	pxc-shra****zq0j01.polarx.rds.aliyuncs.com
Port	integer	实例连接端口	3306
VpcId	string	访问端点所在的专有网络 ID。	vpc-uf61h****dj1zg5fqp5x7
VSwitchId	string	虚拟交换机 ID。	vsw-8vbkw****5yh4nrd639ih
NodeAutoEnter	string	节点在被添加或恢复后，是否自动加入集群并开始提供服务	true
NodeRole	string	若希望查询云原生版读写分离架构实例中只读节点的指标，您在传入具体 NodeId 的同时，还需要在本参数传入 READONLY。说明其余情况请无需传入（或传入 MASTER）。	same_azone_as_last
CnNames	array	["pxc-i-vb1sqa7llp","pxc-i-bemprx50ad"]
	string	string	string
Status	string	状态	created

示例

正常返回示例

JSON格式

{
  "RequestId": "6352AC16-76BF-5135-B1EA-ED49293526E6",
  "Data": {
    "CanDeleteCount": 0,
    "Endpoints": [
      {
        "CustomEndpointId": "pxe-b6e****o4pfap1s",
        "Name": "Name",
        "DBInstanceName": "pxc-hz****zoxherr7",
        "ConnectionString": "pxc-shra****zq0j01.polarx.rds.aliyuncs.com",
        "Port": 3306,
        "VpcId": "vpc-uf61h****dj1zg5fqp5x7",
        "VSwitchId": "vsw-8vbkw****5yh4nrd639ih",
        "NodeAutoEnter": "true",
        "NodeRole": "same_azone_as_last",
        "CnNames": [
          "string"
        ],
        "Status": "created"
      }
    ]
  }
}

错误码

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

变更历史

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