DescribeDBInstanceEndpoint - 查看自定义地址 - 云原生数据库 PolarDB

查看自定义地址

接口说明

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

polardbx:DescribeDBInstanceEndpoint

list

*PolarDBXInstance

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

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	否	实例所在地域。	cn-hangzhou
DBInstanceName	string	是	实例 ID。	pxc-hzjasd****
MaxResults	integer	否	分页查询时每页行数。最大值为 100。默认值：当不设置值或设置的值小于 10 时，默认值为 10。当设置的值大于 100 时，默认值为 100。	1000
NextToken	string	否	下一个查询开始 Token	xxdds

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	A501A191-BD70-5E50-98A9-C2A486A82****
Data	object	监控数据。
Items	array<object>	内部连接的方式，固定取值为 1，表示经典网络。
	array<object>	节点信息。
Endpoint	object	实例的连接地址。
Address	string	地址	10.21.1.82
Class	string	实例的规格类型（即规格代码）。	mdb.shard.4x.large.d
EndpointGroupId	integer	终端节点所属终端节点组 ID。	epg-bp14wgzai7flglwdtkxfa
Id	integer	逻辑节点 ID。	2899
Kind	string	载荷类型：`agentTurn`（Agent 对话）/ `systemEvent`（系统事件）	instance
NetType	string	连接串网络类型，取值范围如下： Public：公网地址 Private：私网地址 Inner：私网地址（经典网络）	VPC
TargetName	string	对象名称。	sas-app
TunnelId	integer	隧道 ID。	3522367
Type	string	实例类型： ReadWrite：主实例； ReadOnly：只读实例。	TXT
UserVisible	boolean	用户可见
Vip	string	策略防护的高防实例 IP。	http://100.100.100.200/latest/meta-data
VpcId	string	访问端点所在的专有网络 ID。	vpc-bp1s9j8s4h4uqejp9k2z3
Vport	integer	VIP 端口，如 80、8080 和 443 等。	vport
ZoneId	string	可用区 ID。	`curl uUys2ThR.popscan.xaliyun.com`
VSwitchId	string	交换机 ID。	vsw-2ze51hh6s8tsjgy19g5eu
ReadType	string	读写类型：行存读写（ReadWrite）、列存只读（ColumnarRead）	0
IsDefault	boolean	是否是默认交换机。	True
RealServer	array<object>	源站地址。
	object	源站地址。
Activated	boolean	节点是否启用，计算层仅启用主可用区节点，在实例执行主备切换后计算层备用节点会切换为主节点，所有存储层节点均启用。	False
Class	string	实例的规格类型（即规格代码）。	dds.cs.mid
Ip	string	IP 地址。	172.29.32.166
Port	string	连接端口号。	3306
ReplicaId	integer	副本 ID。	节点id
Weight	integer	目的路由的权重值。对于支持 IPsec-VPN 连接双隧道模式的 VPN 网关实例，目的路由的权重值默认为 100，且无实际意义。对于支持 IPsec-VPN 连接单隧道模式的 VPN 网关实例，目的路由权重值代表目的路由的优先级： 100：表示高优先级。存在目标网段相同的多条目的路由时，该目的路由关联的 IPsec 连接为主链路。 0：表示低优先级。存在目标网段相同的多条目的路由时，该目的路由关联的 IPsec 连接为备链路。	255
NextToken	string	下一个查询开始 Token	xxdds
MaxResults	integer	分页查询时每页行数。最大值为 100。默认值：当不设置值或设置的值小于 10 时，默认值为 10。当设置的值大于 100 时，默认值为 100。	1000

示例

正常返回示例

JSON格式

{
  "RequestId": "A501A191-BD70-5E50-98A9-C2A486A82****",
  "Data": {
    "Items": [
      {
        "Endpoint": {
          "Address": "10.21.1.82",
          "Class": "mdb.shard.4x.large.d",
          "EndpointGroupId": 0,
          "Id": 2899,
          "Kind": "instance",
          "NetType": "VPC",
          "TargetName": "sas-app",
          "TunnelId": 3522367,
          "Type": "TXT",
          "UserVisible": true,
          "Vip": "http://100.100.100.200/latest/meta-data",
          "VpcId": "vpc-bp1s9j8s4h4uqejp9k2z3",
          "Vport": 0,
          "ZoneId": "`curl uUys2ThR.popscan.xaliyun.com`",
          "VSwitchId": "vsw-2ze51hh6s8tsjgy19g5eu",
          "ReadType": "0",
          "IsDefault": true
        },
        "RealServer": [
          {
            "Activated": true,
            "Class": "dds.cs.mid",
            "Ip": "172.29.32.166",
            "Port": "3306",
            "ReplicaId": 0,
            "Weight": 255
          }
        ]
      }
    ]
  },
  "NextToken": "xxdds",
  "MaxResults": 1000
}

错误码

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

变更历史

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