查询节点健康状态列表-ListNodeHealth

功能介绍

分页查询指定集群下节点的健康状态列表。

支持通过 hypernode_id 或 node_category 筛选节点。

调试

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

授权信息

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

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
aics::listNodeHealth	List	-	-	-	-

URI

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

表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 Query参数
参数	是否必选	参数类型	描述
limit	否	Integer	参数解释: 分页查询单页记录数量。约束限制: 不涉及。取值范围: 1~100。默认取值: 20。
marker	否	String	参数解释: 分页标记，本次请求获取该标记后的资源，base64编码。约束限制: 不涉及。取值范围: 不涉及。默认取值: 不涉及。
node_category	否	String	参数解释: 节点类别。约束限制: 不涉及。取值范围: NODE：单节点（非超节点下节点）。 HYPERNODE_NODE：超节点下的节点。默认取值: 不传则查询所有类别。
hypernode_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}。默认取值: 不涉及。

请求参数

表3 请求Header参数
参数	是否必选	参数类型	描述
X-Auth-Token	否	String	参数解释: 用户Token，通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。约束限制: 不涉及。取值范围: 不涉及。默认取值: 不涉及。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
node_health	Array of NodeHealthView objects	参数解释: 节点健康状态列表。取值范围: 不涉及。
page_info	PageInfo object	参数解释: 分页信息。取值范围: 不涉及。

表5 NodeHealthView
参数	参数类型	描述
node_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}。
hypernode_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}。
health_status	String	参数解释: 节点健康状态取值范围: healthy：健康 sub_healthy：亚健康 faulty：故障 maintaining：运维中

表6 PageInfo
参数	参数类型	描述
next_marker	String	参数解释: 以单页最后一条资源标识作为分页标记，base64编码。用于请求下一页使用的分页标记。取值范围: 不涉及。
current_count	Integer	参数解释 : 当前查询结果数量。取值范围 : 不涉及。

请求示例

查询集群下所有节点健康状态请求示例。使用场景：客户查看集群下所有节点的健康状态。
```
GET https://{endpoint}/v2/0605767a3300d5762fb7c0186d9e1779/node-health/a1b2c3d4-e5f6-7890-abcd-ef1234567890?limit=10
```
查询集群下单节点健康状态请求示例。使用场景：客户查看集群下单节点（非超节点下节点）的健康状态。
```
GET https://{endpoint}/v2/0605767a3300d5762fb7c0186d9e1779/node-health/a1b2c3d4-e5f6-7890-abcd-ef1234567890?node_category=NODE&limit=10
```

查询指定超节点下节点健康状态请求示例。使用场景：客户查看某超节点下所有节点的健康状态。

GET https://{endpoint}/v2/0605767a3300d5762fb7c0186d9e1779/node-health/a1b2c3d4-e5f6-7890-abcd-ef1234567890?hypernode_id=b1c2d3e4-f5a6-7890-abcd-ef1234567890&limit=10

响应示例

状态码：200

{
  "node_health" : [ {
    "node_id" : "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "hypernode_id" : "b1c2d3e4-f5a6-7890-abcd-ef1234567890",
    "health_status" : "healthy"
  } ],
  "page_info" : {
    "next_marker" : null,
    "current_count" : 1
  }
}

状态码

状态码	描述
200	查询成功，返回节点健康状态列表

错误码

请参见错误码。

父主题： 节点健康

上一篇：节点健康

下一篇：查询节点健康状态统计-ShowNodeHealthSummary