DescribeDBClusterNode - 查询节点信息 - 云原生数据仓库AnalyticDB

接口说明

使用说明

本接口用于查看存储弹性模式和 Serverless 版本的 AnalyticDB PostgreSQL 版实例的 Master 节点或 Segment 节点信息。

QPS 限制

本接口的单用户 QPS 限制默认为 1000 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

gpdb:DescribeDBClusterNode

get

*DBInstance

acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}

无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。说明您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情，包括实例 ID。	gp-bp***************
NodeType	string	否	节点类型。取值说明： master：Master 节点。 segment：Segment 节点。说明如果不传入该参数，则返回所有节点的监控信息。	master

返回参数

名称	类型	描述	示例值
	object
Nodes	array<object>	节点列表。
	object
Name	string	节点名称。	master-10*******
RequestId	string	请求 ID。	87E44B48-B306-4AD3-A63B-C8**********
DBClusterId	string	实例 ID。	gp-bp***************

示例

正常返回示例

JSON格式

{
  "Nodes": [
    {
      "Name": "master-10*******"
    }
  ],
  "RequestId": "87E44B48-B306-4AD3-A63B-C8**********",
  "DBClusterId": "gp-bp***************"
}

错误码

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

变更历史

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