ListAllInstances - Alibaba Cloud Linux - Alibaba Cloud Documentation Center

Retrieves a list of managed and unmanaged instances along with their instance information.

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

list

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
region	string	No	The region ID.	cn-hangzhou
instanceType	string	No	The instance type.	ecs
managedType	string	No	The management type.	managed
filters	string	No	The list of filter conditions.	{}
current	string	No	The current page number.	1
pageSize	string	No	The number of entries per page. Default value: 10.	10
pluginId	string	No	The plugin ID.	01fc4a0b-f199-4885-9861-b4054a310fe7
maxResults	integer	No	The maximum number of entries to return in a single request.	100
nextToken	string	No	The pagination token. Note If this parameter is not empty, more data is available.	U+w1wv2R4ZWR5oZLXD0+Dp4dD+2BRJj42DLT6GrZysw=
X-Debug-Id	string	No
x-sysom-invoke-source	string	No

Response elements

Element	Type	Description	Example
	object	Schema of Response
requestId	string	Id of the request	2D693121-C925-5154-8DF6-C09A8B369822
code	string	The status code.	Success
message	string	The error message. If `code == Success`, this field is empty. Otherwise, this field contains the error message of the request.	instance not exists
total	integer	The total number of query results.	2
data	array<object>	The returned data.
	array<object>	The returned results.
instanceId	string	The instance ID.	i-bp17uabeke9v7n30abm2
osHealthScore	integer	The operating system health score.	100
resourceGroupName	string	The resource group name.	xxxx
instanceName	string	The instance name.	test
installType	string	The installation type.	console
instanceType	string	The instance type.	ecs
installLevel	string	The installation level.	Cluster
attributes	array<object>	The extended information.
	object	The extended information.
infoValue	string	The information value.	diagnosis
infoType	string	The information type.	instance_tag
infoKey	string	The information key.	sysom
resourceGroupId	string	The resource group ID.	3b24a621-acb3-11ef-8c90-00163e1029af
osName	string	The operating system name.	alios
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
clusterId	string	The cluster ID.	3b24a621-acb3-11ef-8c90-00163e1029af
osArch	string	The operating system architecture.	x86_64
kernelVersion	string	The kernel version.	5.10.134-18.al8.x86_64
imageId	string	The image ID.	aliyun_3_x64_20G_alibase_20250117.vhd
manageType	string	The management type.	managed
manageLevel	string	The management level.	cluster
clusterName	string	The cluster name.	zjk_vpc_domain_1
publicIp	string	The public IP address.	47.98.215.58
privateIp	string	The private IP address.	172.21.172.7
agentConfigId	string	The agent configuration ID.	test_id
agentConfigName	string	The agent configuration name.	test_name
maxResults	integer	The maximum number of entries returned.	20
nextToken	string	The pagination token. Note A non-empty value indicates that more data is available.	c2f78a783f49457caba6bace6f6f79e4

Examples

Success response

JSON format

{
  "requestId": "2D693121-C925-5154-8DF6-C09A8B369822\n",
  "code": "Success",
  "message": "instance not exists",
  "total": 2,
  "data": [
    {
      "instanceId": "i-bp17uabeke9v7n30abm2",
      "osHealthScore": 100,
      "resourceGroupName": "xxxx",
      "instanceName": "test",
      "installType": "console",
      "instanceType": "ecs",
      "installLevel": "Cluster",
      "attributes": [
        {
          "infoValue": "diagnosis",
          "infoType": "instance_tag",
          "infoKey": "sysom"
        }
      ],
      "resourceGroupId": "3b24a621-acb3-11ef-8c90-00163e1029af",
      "osName": "alios",
      "status": "Running",
      "clusterId": "3b24a621-acb3-11ef-8c90-00163e1029af",
      "osArch": "x86_64",
      "kernelVersion": "5.10.134-18.al8.x86_64",
      "imageId": "aliyun_3_x64_20G_alibase_20250117.vhd",
      "manageType": "managed",
      "manageLevel": "cluster",
      "clusterName": "zjk_vpc_domain_1",
      "publicIp": "47.98.215.58",
      "privateIp": "172.21.172.7",
      "agentConfigId": "test_id",
      "agentConfigName": "test_name"
    }
  ],
  "maxResults": 20,
  "nextToken": "c2f78a783f49457caba6bace6f6f79e4"
}

Error codes

HTTP status code	Error code	Error message	Description
400	Sysom.ServerError	Server error, please correct the code according to the error message. %s.	Server error, please correct the code according to the error message

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.