DescribePolarxDataNodes - 查看数据节点信息 - 云原生数据库 PolarDB

该接口用于查询PolarDB-X实例中所有数据节点（Data Nodes）的详细信息，包括节点状态、存储使用情况、网络地址等，便于运维管理和监控。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

polardbx:DescribePolarxDataNodes

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
RegionId	string	是	实例所在地域。	cn-shanghai
PageNumber	integer	否	页码。取值为大于 0 且不超过 integer 数据类型的最大值，默认值为 1。	1
PageSize	integer	否	每页记录数。	30
NodeType	string	否	查询节点类型 all: 表示同时查询 dn 与 gms 节点 gms: 表示只查询 gms 节点 dn: 表示只查询 dn 节点	dn
SearchKey	string	否	关键词	pc-bp1c5w4fx****2274

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 id。	BD99340C-4A45-548B-****-27584B0BCFFF
PageNumber	integer	页码。	1
PageSize	integer	每页记录数。	0
TotalNumber	integer	总节点数。	0
DBInstanceDataNodes	array<object>	节点信息列表。
	object	节点信息列表。
DBInstanceName	string	实例 id。	pxc-hzrp5m****04w4
DBInstanceId	string	实例 id。	pxc-hzrlcjc****sz9
DBInstanceDescription	string	节点实例描述。	pxc-z****nfxsxy728 : PROD-OMS-Auto-生产库克隆实例

示例

正常返回示例

JSON格式

{
  "RequestId": "BD99340C-4A45-548B-****-27584B0BCFFF",
  "PageNumber": 1,
  "PageSize": 0,
  "TotalNumber": 0,
  "DBInstanceDataNodes": [
    {
      "DBInstanceName": "pxc-hzrp5m****04w4",
      "DBInstanceId": "pxc-hzrlcjc****sz9",
      "DBInstanceDescription": "pxc-z****nfxsxy728 : PROD-OMS-Auto-生产库克隆实例"
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidPageSize.Malformed	The specified parameter PageSize is not valid.	分页格式非法

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

变更历史

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