DescribeHealthStatus - 查看实例和节点的健康状态 - 云原生数据仓库AnalyticDB

查看实例和节点的健康状态。

接口说明

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

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

gpdb:DescribeHealthStatus

get

*DBInstance

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

无

请求参数

名称	类型	必填	描述	示例值
DBInstanceId	string	是	实例 ID。说明您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情，包括实例 ID。	gp-bp12ga6v69h86****
Key	string	是	性能参数名称，多个指标用英文半角（,）分隔，具体信息，请参见性能参数表。	node_master_status,node_master_connection_status,node_segment_connection_status,node_segment_disk_status

返回参数

名称	类型	描述	示例值
	object
Status	object	性能监控具体信息，由参数名、状态和和指标值构成。只有请求参数 Key 中传入了性能参数才会返回对应的监控信息，例如请求参数 Key 仅包含adbpg_status，则返回信息中仅返回adbpg_status的监控信息。更多性能参数信息，请参见性能参数表。	{"node_master_connection_status":{"Status":"healthy","Value":1.6}}
adbpg_status	object	实例健康状态。
Status	string	实例健康状态。取值说明： critical：任意一个 Master 节点或 Segment 节点不可用，控制台显示为红色。 healthy：所有节点均可用，控制台显示为绿色。	healthy
Value	number	实例健康状态的指标值。取值说明： 1 表示 healthy。 0 表示 critical。	1
adbpg_connection_status	object	实例连接状态。
Status	string	实例连接状态。取值说明： critical：实例连接数使用率大于 95%，控制台显示为红色。 warning：实例连接数使用率大于 90%且小于等于 95%，控制台显示为黄色。 healthy：实例连接数使用率小于等于 90%，控制台显示为绿色。说明实例连接数使用率为所有 Master 节点和 Segment 节点的连接数使用率的最大值。	healthy
Value	number	实例连接数使用率的指标值，即所有 Master 节点和 Segment 节点的连接数使用率的最大值。单位：%。	1.71
adbpg_disk_status	object	实例存储状态。说明仅存储弹性模式会返回该值。
Status	string	实例存储状态。取值说明： critical：实例存储水位大于等于 90%，控制台显示为红色，实例将被锁定。 warning：实例存储水位大于等于 70%且小于 90%，控制台显示为黄色。 healthy：实例存储水位小于 70%，控制台显示为绿色，实例存储状态健康。说明实例存储水位为所有 Segment 节点的存储水位的平均值。	healthy
Value	number	实例存储水位的指标值，即所有 Segment 节点的存储水位的平均值。单位：%。	1.52
adbpg_disk_usage_percent	object	实例存储水位。说明仅存储弹性模式会返回该值。
Status	string	实例存储水位状态。取值说明： critical：实例存储水位大于等于 90%，实例将被锁定。 warning：实例存储水位大于等于 70%且小于 90%。 healthy：实例存储水位小于 70%，实例存储状态健康。说明实例存储水位为所有 Segment 节点的存储水位的平均值。	healthy
Value	number	实例存储水位的指标值，所有 Segment 节点的存储水位的平均值。单位：%。	1.52
adbpg_master_disk_usage_percent_max	object	最大实例协调节点存储水位，即实例下所有 Master 节点中的最大存储水位。说明仅存储弹性模式会返回该值。
Status	string	Master 节点最大存储水位状态。取值说明： critical：水位大于等于 90%，实例将被锁定。 warning：水位大于等于 70%且小于 90%。 healthy：水位小于 70%，实例存储状态健康。	healthy
Value	number	Master 节点最大存储水位的指标值。单位：%。	1.34
adbgp_segment_disk_usage_percent_max	object	最大实例计算节点存储水位，即实例下所有 Segment 节点中的最大存储水位。说明仅存储弹性模式会返回该值。
Status	string	Segment 节点最大存储水位状态。取值说明： critical：水位大于等于 90%，实例将被锁定。 warning：水位大于等于 80%且小于 90%。 healthy：水位小于 80%，实例存储状态健康。	healthy
Value	number	Segment 节点最大存储水位的指标值。单位：%。	1.52
node_master_status	object	协调节点健康状态，即 Master 节点的健康状态。
Status	string	Master 节点健康状态。取值说明： critical：任意一个主 Master 节点或副 Master 节点不可用，控制台显示为红色。 healthy：所有 Master 节点均可用，控制台显示为绿色。	healthy
Value	number	Master 节点健康状态的指标值。取值说明： 1 表示 healthy。 0 表示 critical。	1
node_segment_disk_status	object	计算节点存储状态，即 Segment 节点的存储状态。说明仅存储弹性模式会返回该值。
Status	string	Segment 节点存储状态。取值说明： critical：Segment 节点存储水位大于等于 90%，控制台显示为红色，实例将被锁定。 warning：Segment 节点存储水位大于等于 80%且小于 90%，控制台显示为黄色。 healthy：Segment 节点存储水位小于 80%，控制台显示为绿色，实例存储状态健康。说明 Segment 节点存储水位为所有 Segment 节点的存储水位的最大值。	healthy
Value	number	Segment 节点的最大存储水位的指标值。单位：%。	1.52
node_master_connection_status	object	协调节点连接健康状态，即 Master 节点的连接健康状态。
Status	string	Master 节点连接健康状态。取值说明： critical：Master 节点连接数使用率大于等于 95%，控制台显示为红色。 warning：Master 节点连接数使用率大于等于 90%且小于 95%，控制台显示为黄色。 healthy：Master 节点连接数使用率小于 90%，控制台显示为绿色。说明 Master 节点连接数使用率为所有 Master 节点中连接数使用率的最大值。	healthy
Value	number	Master 节点的连接数使用率的指标值，即所有 Master 节点中连接数使用率的最大值。单位：%。	1.71
node_segment_connection_status	object	计算节点连接健康状态，即 Segment 节点的连接健康状态。
Status	string	Segment 节点连接健康状态。取值说明： critical：Segment 节点连接数使用率大于等于 95%，控制台显示为红色。 warning：Segment 节点连接数使用率大于等于 90%且小于 95%，控制台显示为黄色。 healthy：Segment 节点连接数使用率小于 90%，控制台显示为绿色。说明 Segment 节点的连接数使用率为所有 Segment 节点中的连接数使用率最大值。	healthy
Value	number	Segment 节点的连接数使用率的指标值，即所有 Segment 节点中连接数使用率的最大值。单位：%。	0.48
adbpg_master_status	object	协调节点状态，即 Master 节点的可用状态。
Status	string	Master 节点的可用状态。取值说明： critical：主备节点均不可用，控制台显示为红色。 warning：主节点或备节点不可用，控制台显示为黄色。 healthy：所有节点均可用，控制台显示为绿色。	healthy
Value	number	Master 节点的可用状态的指标值。取值说明：	1
adbpg_segment_status	object	计算节点状态，即 Segment 节点的可用状态。
Status	string	Segment 节点的可用状态。取值说明： critical：主备节点均不可用，控制台显示为红色。 warning：大于等于 50%节点不可用，控制台显示为黄色。 healthy：所有节点均可用，控制台显示为绿色。	healthy
Value	number	Segment 节点的可用状态的指标值。	1
adbpg_instance_total_data_gb	object	实例存储数据总量。
Value	number	实例存储数据总量，单位 GB。	4.1
adbpg_instance_hot_data_gb	object	热数据存储总量。
Value	number	热数据存储总量，单位 GB。	4.1
adbpg_instance_cold_data_gb	object	冷数据存储总量
Value	number	冷数据存储总量，单位 GB。	0
RequestId	string	请求 ID。	D97B4191-104D-10CE-8BC5-53**********
DBClusterId	string	实例 ID。	gp-bp12ga6v69h86****

示例

正常返回示例

JSON格式

{
  "Status": {
    "adbpg_status": {
      "Status": "healthy",
      "Value": 1
    },
    "adbpg_connection_status": {
      "Status": "healthy",
      "Value": 1.71
    },
    "adbpg_disk_status": {
      "Status": "healthy",
      "Value": 1.52
    },
    "adbpg_disk_usage_percent": {
      "Status": "healthy",
      "Value": 1.52
    },
    "adbpg_master_disk_usage_percent_max": {
      "Status": "healthy",
      "Value": 1.34
    },
    "adbgp_segment_disk_usage_percent_max": {
      "Status": "healthy",
      "Value": 1.52
    },
    "node_master_status": {
      "Status": "healthy",
      "Value": 1
    },
    "node_segment_disk_status": {
      "Status": "healthy",
      "Value": 1.52
    },
    "node_master_connection_status": {
      "Status": "healthy",
      "Value": 1.71
    },
    "node_segment_connection_status": {
      "Status": "healthy",
      "Value": 0.48
    },
    "adbpg_master_status": {
      "Status": "healthy",
      "Value": 1
    },
    "adbpg_segment_status": {
      "Status": "healthy",
      "Value": 1
    },
    "adbpg_instance_total_data_gb": {
      "Value": 4.1
    },
    "adbpg_instance_hot_data_gb": {
      "Value": 4.1
    },
    "adbpg_instance_cold_data_gb": {
      "Value": 0
    }
  },
  "RequestId": "D97B4191-104D-10CE-8BC5-53**********",
  "DBClusterId": "gp-bp12ga6v69h86****"
}

错误码

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

变更历史

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