调用DescribeHealthStatus接口查看实例和节点的健康状态。

使用说明

本接口用于查看存储弹性模式和Serverless版本的AnalyticDB PostgreSQL版的实例、协调节点(也称Master节点)以及计算节点(也称Segment节点)的健康状态。

QPS限制

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

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

调试

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

请求参数

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

系统规定参数。取值:DescribeHealthStatus

DBInstanceId String gp-bp12ga6v69h86****

实例ID。

说明 您可以调用DescribeDBInstances接口查看目标地域下所有的AnalyticDB PostgreSQL实例的详情,包括实例ID。
Key String node_master_status,node_master_connection_status,node_segment_connection_status,node_segment_disk_status

性能参数名称,多个指标用英文半角(,)分隔,具体信息,请参见性能参数表

返回数据

名称 类型 示例值 描述
Status Object

性能监控具体信息,由参数名、状态和和指标值构成。只有请求参数Key中传入了性能参数才会返回对应的监控信息,例如请求参数Key仅包含adbpg_status,则返回信息中仅返回adbpg_status的监控信息。

更多性能参数信息,请参见性能参数表

adbpg_status Object

实例健康状态。

Status String healthy

实例健康状态。取值说明:

  • critical:任意一个Master节点或Segment节点不可用,控制台显示为红色。
  • healthy:所有节点均可用,控制台显示为绿色。
Value Float 1

实例健康状态的指标值。取值说明:

  • 1表示healthy。
  • 0表示critical。
adbpg_connection_status Object

实例连接状态。

Status String healthy

实例连接状态。取值说明:

  • critical:实例连接数使用率大于95%,控制台显示为红色。
  • warning:实例连接数使用率大于90%且小于等于95%,控制台显示为黄色。
  • healthy:实例连接数使用率小于等于90%,控制台显示为绿色。
说明 实例连接数使用率为所有Master节点和Segment节点的连接数使用率的最大值。
Value Float 1.71

实例连接数使用率的指标值,即所有Master节点和Segment节点的连接数使用率的最大值。

单位:%。

adbpg_disk_status Object

实例存储状态。

说明 仅存储弹性模式会返回该值。
Status String healthy

实例存储状态。取值说明:

  • critical:实例存储水位大于等于90%,控制台显示为红色,实例将被锁定。
  • warning:实例存储水位大于等于70%且小于90%,控制台显示为黄色。
  • healthy:实例存储水位小于70%,控制台显示为绿色,实例存储状态健康。
说明 实例存储水位为所有Segment节点的存储水位的平均值。
Value Float 1.52

实例存储水位的指标值,即所有Segment节点的存储水位的平均值。

单位:%。

adbpg_disk_usage_percent Object

实例存储水位。

说明 仅存储弹性模式会返回该值。
Status String healthy

实例存储水位状态。取值说明:

  • critical:实例存储水位大于等于90%,实例将被锁定。
  • warning:实例存储水位大于等于70%且小于90%。
  • healthy:实例存储水位小于70%,实例存储状态健康。
说明 实例存储水位为所有Segment节点的存储水位的平均值。
Value Float 1.52

实例存储水位的指标值,所有Segment节点的存储水位的平均值。

单位:%。

adbpg_master_disk_usage_percent_max Object

最大实例协调节点存储水位,即实例下所有Master节点中的最大存储水位。

说明 仅存储弹性模式会返回该值。
Status String healthy

Master节点最大存储水位状态。取值说明:

  • critical:水位大于等于90%,实例将被锁定。
  • warning:水位大于等于70%且小于90%。
  • healthy:水位小于70%,实例存储状态健康。
Value Float 1.34

Master节点最大存储水位的指标值。

单位:%。

adbgp_segment_disk_usage_percent_max Object

最大实例计算节点存储水位,即实例下所有Segment节点中的最大存储水位。

说明 仅存储弹性模式会返回该值。
Status String healthy

Segment节点最大存储水位状态。取值说明:

  • critical:水位大于等于90%,实例将被锁定。
  • warning:水位大于等于80%且小于90%。
  • healthy:水位小于80%,实例存储状态健康。
Value Float 1.52

Segment节点最大存储水位的指标值。

单位:%。

node_master_status Object

协调节点健康状态,即Master节点的健康状态。

Status String healthy

Master节点健康状态。取值说明:

  • critical:任意一个主Master节点或副Master节点不可用,控制台显示为红色。
  • healthy:所有Master节点均可用,控制台显示为绿色。
Value Float 1

Master节点健康状态的指标值。取值说明:

  • 1表示healthy。
  • 0表示critical。
node_segment_disk_status Object

计算节点存储状态,即Segment节点的存储状态。

说明 仅存储弹性模式会返回该值。
Status String healthy

Segment节点存储状态。取值说明:

  • critical:Segment节点存储水位大于等于90%,控制台显示为红色,实例将被锁定。
  • warning:Segment节点存储水位大于等于80%且小于90%,控制台显示为黄色。
  • healthy:Segment节点存储水位小于80%,控制台显示为绿色,实例存储状态健康。
说明 Segment节点存储水位为所有Segment节点的存储水位的最大值。
Value Float 1.52

Segment节点的最大存储水位的指标值。

单位:%。

node_master_connection_status Object

协调节点连接健康状态,即Master节点的连接健康状态。

Status String healthy

Master节点连接健康状态。取值说明:

  • critical:Master节点连接数使用率大于等于95%,控制台显示为红色。
  • warning:Master节点连接数使用率大于等于90%且小于95%,控制台显示为黄色。
  • healthy:Master节点连接数使用率小于90%,控制台显示为绿色。
说明 Master节点连接数使用率为所有Master节点中连接数使用率的最大值。
Value Float 1.71

Master节点的连接数使用率的指标值,即所有Master节点中连接数使用率的最大值。

单位:%。

node_segment_connection_status Object

计算节点连接健康状态,即Segment节点的连接健康状态。

Status String healthy

Segment节点连接健康状态。取值说明:

  • critical:Segment节点连接数使用率大于等于95%,控制台显示为红色。
  • warning:Segment节点连接数使用率大于等于90%且小于95%,控制台显示为黄色。
  • healthy:Segment节点连接数使用率小于90%,控制台显示为绿色。
说明 Segment节点的连接数使用率为所有Segment节点中的连接数使用率最大值。
Value Float 0.48

Segment节点的连接数使用率的指标值,即所有Segment节点中连接数使用率的最大值。

单位:%。

adbpg_master_status Object

协调节点状态,即Master节点的可用状态。

Status String healthy

Master节点的可用状态。取值说明:

  • critical:主备节点均不可用,控制台显示为红色。
  • warning:主节点或备节点不可用,控制台显示为黄色。
  • healthy:所有节点均可用,控制台显示为绿色。
Value Float 1

Master节点的可用状态的指标值。取值说明:

adbpg_segment_status Object

计算节点状态,即Segment节点的可用状态。

Status String healthy

Segment节点的可用状态。取值说明:

  • critical:主备节点均不可用,控制台显示为红色。
  • warning:大于等于50%节点不可用,控制台显示为黄色。
  • healthy:所有节点均可用,控制台显示为绿色。
Value Float 1

Segment节点的可用状态的指标值。

RequestId String D97B4191-104D-10CE-8BC5-53**********

请求ID。

DBClusterId String gp-bp12ga6v69h86****

实例ID。

示例

请求示例

http(s)://gpdb.aliyuncs.com/?Action=DescribeHealthStatus
&DBInstanceId=gp-bp12ga6v69h86****
&Key=node_master_status,node_master_connection_status,node_segment_connection_status,node_segment_disk_status
&公共请求参数

正常返回示例

XML格式

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

<DescribeHealthStatusResponse>
    <code>200</code>
    <data>
        <Status>
            <adbpg_status>
                <Status>healthy</Status>
                <Value>1</Value>
            </adbpg_status>
            <adbpg_connection_status>
                <Status>healthy</Status>
                <Value>1.71</Value>
            </adbpg_connection_status>
            <adbgp_segment_disk_usage_percent_max>
                <Status>healthy</Status>
                <Value>1.52</Value>
            </adbgp_segment_disk_usage_percent_max>
            <adbpg_master_disk_usage_percent_max>
                <Status>healthy</Status>
                <Value>1.34</Value>
            </adbpg_master_disk_usage_percent_max>
            <adbpg_disk_usage_percent>
                <Status>healthy</Status>
                <Value>1.52</Value>
            </adbpg_disk_usage_percent>
            <adbpg_disk_status>
                <Status>healthy</Status>
                <Value>1.52</Value>
            </adbpg_disk_status>
            <node_master_connection_status>
                <Status>healthy</Status>
                <Value>1.71</Value>
            </node_master_connection_status>
            <node_master_status>
                <Status>healthy</Status>
                <Value>1</Value>
            </node_master_status>
            <node_segment_connection_status>
                <Status>healthy</Status>
                <Value>0.48</Value>
            </node_segment_connection_status>
            <node_segment_disk_status>
                <Status>healthy</Status>
                <Value>1.52</Value>
            </node_segment_disk_status>
        </Status>
        <RequestId>D97B4191-104D-10CE-8BC5-53**********</RequestId>
        <DBClusterId>gp-bp12ga6v69h86****</DBClusterId>
    </data>
    <httpStatusCode>200</httpStatusCode>
    <requestId>D97B4191-104D-10CE-8BC5-53**********</requestId>
    <successResponse>true</successResponse>
</DescribeHealthStatusResponse>

JSON格式

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

{
  "code" : "200",
  "data" : {
    "Status" : {
      "adbpg_status" : {
        "Status" : "healthy",
        "Value" : 1.0
      },
      "adbpg_connection_status" : {
        "Status" : "healthy",
        "Value" : 1.71
      },
      "adbgp_segment_disk_usage_percent_max" : {
        "Status" : "healthy",
        "Value" : 1.52
      },
      "adbpg_master_disk_usage_percent_max" : {
        "Status" : "healthy",
        "Value" : 1.34
      },
      "adbpg_disk_usage_percent" : {
        "Status" : "healthy",
        "Value" : 1.52
      },
      "adbpg_disk_status" : {
        "Status" : "healthy",
        "Value" : 1.52
      },
      "node_master_connection_status" : {
        "Status" : "healthy",
        "Value" : 1.71
      },
      "node_master_status" : {
        "Status" : "healthy",
        "Value" : 1.0
      },
      "node_segment_connection_status" : {
        "Status" : "healthy",
        "Value" : 0.48
      },
      "node_segment_disk_status" : {
        "Status" : "healthy",
        "Value" : 1.52
      }
    },
    "RequestId" : "D97B4191-104D-10CE-8BC5-53**********",
    "DBClusterId" : "gp-bp12ga6v69h86****"
  },
  "httpStatusCode" : "200",
  "requestId" : "D97B4191-104D-10CE-8BC5-53**********",
  "successResponse" : true
}

错误码

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