文档首页/ 灵衢智算集群 AICS/ API参考/ API/ 节点健康/ 查询节点健康状态统计-ShowNodeHealthSummary
更新时间:2026-10-20 GMT+08:00
分享

查询节点健康状态统计-ShowNodeHealthSummary

功能介绍

查询节点健康状态统计,按健康状态分组返回节点数量。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

授权信息

账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

aics::getNodeHealthSummary

Read

-

-

-

-

URI

GET /v2/{project_id}/node-health/{cluster_id}/summary

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,获取方法请参见获取项目ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

cluster_id

是

String

参数解释:

集群唯一标识UUID。查询指定集群下节点的健康状态。

约束限制:

不涉及。

取值范围:

UUID格式,[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

否

String

参数解释:

用户Token,通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

health_summary

health_summary object

节点健康状态统计

表4 health_summary

参数

参数类型

描述

healthy

Integer

健康节点数量

sub_healthy

Integer

亚健康节点数量

faulty

Integer

故障节点数量

maintaining

Integer

运维中节点数量

total

Integer

节点总数

请求示例

查询节点健康状态统计请求示例。使用场景:客户查看集群节点健康状态概览。

GET https://{endpoint}/v2/0605767a3300d5762fb7c0186d9e1779/node-health/a1b2c3d4-e5f6-7890-abcd-ef1234567890/summary

响应示例

状态码:200

{
  "health_summary" : {
    "healthy" : 10,
    "sub_healthy" : 2,
    "faulty" : 1,
    "maintaining" : 3,
    "total" : 16
  }
}

状态码

状态码

描述

200

查询成功,返回节点健康状态统计

错误码

请参见错误码。

相关文档