ListInstances - Alibaba Cloud Linux - Alibaba Cloud Documentation Center

Retrieves the list of managed instances.

Operation description

This operation retrieves the list of instances that are already managed by SysOM. If an ECS instance exists but is not managed by SysOM, it does not appear in the list.

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:ListInstances

list

*All Resource

*

None

Request syntax

GET /api/v1/am/instance/list_instances HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
current	integer	No	The current page number. This field is present when pagination is used.	1
pageSize	integer	No	The number of entries per page. Default value: 20. Valid values: 1 to 100.	10
instance	string	No	The ECS instance ID used to filter results.	i-8vbfd3g9vs32sfuvv38h
status	string	No	Filters instances by status.	Running
region	string	No	Filters instances by region.	cn-shenzhen
cluster_id	string	No	The cluster ID.	xxxxx

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 result.
	object	The returned result.
cluster_id	string	The cluster ID.	c2218ca2b76ec45e7b7ee1693f6fcd374
instance	string	The ECS instance ID.	i-wz9d00ut2ska3mlyhn6j
kernel_version	string	The current kernel version of the instance.	5.10.134-16.1.an8.x86_64
meta	any	The instance metadata.	{ "uname": "Linux", "oncpu": "off", "release": "5.10.134-16.3.al8.aarch64", "monitor": "on", "version_id": "3", "version": "3 (Soaring Falcon)", "podNs": [ ], "machine": "aarch64", "name": "Alibaba Cloud Linux", "sysak": "3.4.0-1", "id": "alinux", "region": "cn-hangzhou", "centos-release": "Alibaba Cloud Linux release 3 (Soaring Falcon)" }
os_arch	string	The architecture of the ECS instance.	x86
os_health_score	string	The health score of the instance.	100
os_name	string	The operating system name of the instance, obtained from /etc/os-release.	Anolis OS
os_name_id	string	The operating system name ID of the instance, obtained from /etc/os-release.	anolis
os_version	string	The operating system version of the instance, obtained from /etc/os-release.	8.9
os_version_id	string	The operating system version ID of the instance, obtained from /etc/os-release.	rhel fedora centos
region	string	The region where the instance resides.	cn-hangzhou
status	string	The status of the instance.	Running
message	string	The error message. If `code == Success`, this field is empty. Otherwise, this field contains the request error information.	Requests for llm service failed
request_id	string	The request ID.	9515E5A0-8905-59B0-9BBF-5F0BE568C3A0
total	integer	The total number of records.	623

Examples

Success response

JSON format

{
  "code": "SysomOpenAPI.ServerError\n",
  "data": [
    {
      "cluster_id": "c2218ca2b76ec45e7b7ee1693f6fcd374",
      "instance": "i-wz9d00ut2ska3mlyhn6j",
      "kernel_version": "5.10.134-16.1.an8.x86_64",
      "meta": "{\n    \"uname\": \"Linux\",\n    \"oncpu\": \"off\",\n    \"release\": \"5.10.134-16.3.al8.aarch64\",\n    \"monitor\": \"on\",\n    \"version_id\": \"3\",\n    \"version\": \"3 (Soaring Falcon)\",\n    \"podNs\": [\n\n    ],\n    \"machine\": \"aarch64\",\n    \"name\": \"Alibaba Cloud Linux\",\n    \"sysak\": \"3.4.0-1\",\n    \"id\": \"alinux\",\n    \"region\": \"cn-hangzhou\",\n    \"centos-release\": \"Alibaba Cloud Linux release 3 (Soaring Falcon)\"\n}",
      "os_arch": "x86",
      "os_health_score": "100",
      "os_name": "Anolis OS",
      "os_name_id": "anolis",
      "os_version": "8.9",
      "os_version_id": "rhel fedora centos",
      "region": "cn-hangzhou",
      "status": "Running"
    }
  ],
  "message": "Requests for llm service failed\n",
  "request_id": "9515E5A0-8905-59B0-9BBF-5F0BE568C3A0",
  "total": 623
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.