调用DescribeDBClusterNode接口查询AnalyticDB PostgreSQL版实例中的节点信息。

使用说明

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

QPS限制

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

本文档中的QPS仅为默认参考值，准确信息请参见API速率配额列表。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 DescribeDBClusterNode

系统规定参数。取值：DescribeDBClusterNode。

DBInstanceId String 是 gp-bp***************

实例ID。

说明 您可以调用DescribeDBInstances接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情，包括实例ID。
NodeType String 否 master

节点类型。取值说明：

  • master：Master节点。
  • segment：Segment节点。
说明 如果不传入该参数，则返回所有节点的监控信息。

返回数据

名称 类型 示例值 描述
Nodes Array of Node

节点列表。
Name String master-10*******

节点名称。
RequestId String 87E44B48-B306-4AD3-A63B-C8**********

请求ID。
DBClusterId String gp-bp***************

实例ID。

示例

请求示例

http(s)://gpdb.aliyuncs.com]/?Action=DescribeDBClusterNode
&DBInstanceId=gp-bp***************
&公共请求参数

正常返回示例

XML格式 

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDBClusterNodeResponse>
    <RequestId>87E44B48-B306-4AD3-A63B-C8**********</RequestId>
    <DBClusterId>gp-bp***************</DBClusterId>
    <Nodes>
        <Name>master-10*******</Name>
    </Nodes>
</DescribeDBClusterNodeResponse>

JSON格式 

HTTP/1.1 200 OK
Content-Type:application/json

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

错误码

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