ListInstanceHealth - Alibaba Cloud Linux - Alibaba Cloud Documentation Center

Retrieves the health status list of cluster nodes or pods within a specified time range.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

sysom:ListInstanceHealth

list

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
cluster	string	No	The cluster ID.	2dc6f3be-bf24-4070-8d3a-c03c26850532
instance	string	No	The instance ID.	i-wz9d00ut2ska3mlyhn6j
start	number	Yes	The start time.	1725797727754
end	number	Yes	The end time.	1725801327754
current	integer	No	The current page number.	1
pageSize	integer	No	The number of entries per page. Default value: 5. Valid values: 1 to 100.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
code	string	The status code. If `code == Success`, the authorization is successful. Other status codes indicate authorization failed. Check the `message` field for the detailed fault information.	SysomOpenAPI.ServerError
data	array<object>	The returned data.
	object	The response data.
images	array	The list of container image names in the pod.
	string	The container image name.	alinux3:latest
instance	string	The instance ID.	i-wz9d00ut2ska3mlyhn6j
namespace	string	The namespace of the pod.	default
pod	string	The pod name.	test-pod
region_id	string	The region ID.	cn-shanghai
score	number	The health score.	100
status	string	The running status of the instance. Valid values: Running: Running. Offline: Offline. Note An instance in the Offline status indicates that the heartbeat between the node and the SysOM server is lost. It does not mean that the corresponding ECS instance is not running.	Running
message	string	The error message. If `code == Success`, this field is empty. Otherwise, this field contains the request error information.	Query no data
request_id	string	The request ID.	35F91AAB-5FDF-5A22-B211-C7C6B00817D0
total	integer	The total number of query results.	42

Examples

Success response

JSON format

{
  "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
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.