ListInstanceHealth - 获取集群中节点/Pod的健康度列表 - Alibaba Cloud Linux

获取一定时间内集群节点/Pod健康度列表

调试

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

调试

授权信息

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

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

操作

访问级别

资源类型

条件关键字

关联操作

sysom:ListInstanceHealth

list

*全部资源

*

无

请求语法

GET /api/v1/openapi/cluster_health/range/instance_health_list HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
cluster	string	否	集群 id	2dc6f3be-bf24-4070-8d3a-c03c26850532
instance	string	否	实例 ID。	i-wz9d00ut2ska3mlyhn6j
start	number	是	开始时间	1725797727754
end	number	是	结束时间	1725801327754
current	integer	否	当前所在分页	1
pageSize	integer	否	每页大小，默认值为 5，取值范围【1,100】	10

返回参数

名称	类型	描述	示例值
	object	Schema of Response
code	string	状态码 `code == Success` 则代表授权成功；其它状态码代表授权失败，授权失败时查看 `message` 字段获取详细的错误信息；	SysomOpenAPI.ServerError
data	array<object>	返回数据。
	object	响应数据。
images	array	Pod 中容器的镜像名称列表
	string	容器镜像名称	alinux3:latest
instance	string	实例 ID。	i-wz9d00ut2ska3mlyhn6j
namespace	string	Pod 所在的命名空间	default
pod	string	Pod 名称	test-pod
region_id	string	地域 ID。	cn-shanghai
score	number	健康分数值。	100
status	string	实例的运行状态，取值： Running：正在运行 Offline：离线说明处于 Offline 状态的实例代表节点到 SysOM 服务端的心跳丢失，并不代表对应的 ECS 实例没有运行。	Running
message	string	错误信息如果 `code == Success`，则本字段为空；否则本字段包含请求错误信息。	Query no data
request_id	string	请求 RequestId	35F91AAB-5FDF-5A22-B211-C7C6B00817D0
total	integer	查询结果总数。	42

示例

正常返回示例

JSON格式

{
  "code": "SysomOpenAPI.ServerError",
  "data": [
    {
      "images": [
        "alinux3:latest"
      ],
      "instance": "i-wz9d00ut2ska3mlyhn6j",
      "namespace": "default",
      "pod": "test-pod",
      "region_id": "cn-shanghai",
      "score": 100,
      "status": "Running"
    }
  ],
  "message": "Query no data",
  "request_id": "35F91AAB-5FDF-5A22-B211-C7C6B00817D0",
  "total": 42
}

错误码

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

变更历史

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