Call ListClusters to retrieve cluster instances - Platform For AI

Query cluster instances with optional filtering by resource group and tags.

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

eflo:ListClusters

get

*Cluster

acs:eflo:{#regionId}:{#accountId}:cluster/*

None

Request parameters

Parameter	Type	Required	Description	Example
NextToken	string	No	Token for retrieving the next page of results. Use the NextToken value returned in the previous response.	a3f2224a5ec7224116c4f5246120abe2
MaxResults	integer	No	Number of entries per page. Default: 20.	20
ResourceGroupId	string	No	Resource group ID.	rg-aek2bg6wyoox6jq
Tags	array<object>	No	List of tags.
	object	No	Tag object.
Key	string	No	Tag key.	my_key
Value	string	No	Tag value.	my_value

Response elements

Element	Type	Description	Example
	object
RequestId	string	Request ID.	2FE2B22C-CF9D-59DE-BF63-DC9B9B33A9D1
Clusters	array<object>	Cluster information.
	array<object>	Cluster object.
Components	any	Component information.	{}
ClusterId	string	Cluster ID.	i137590131672134915401
ClusterName	string	Cluster name.	cnp_test_cluster
OperatingState	string	Cluster status. Valid values: running : Running expanding : Scaling out shrinking : Scaling in initializing : Initializing	initializing
TaskId	string	Task ID.	i156365121663149566024
ClusterType	string	Cluster type. Valid values: AckEdgePro : Lingjun cluster based on ACK@Edge Pro ExclusiveBareCluster : Dedicated bare metal cluster Lite : Basic Lingjun cluster	AckEdgePro
NodeCount	integer	Number of nodes.	12
NodeGroupCount	integer	Number of node groups.	2
CreateTime	string	Cluster creation time.	2026-01-27T14:54:02.360
UpdateTime	string	Last update time.	2026-01-28T20:56:32.585
ClusterDescription	string	Cluster description.	测试集群
ResourceGroupId	string	Resource group ID.	rg-aek2ajbjoloa23q
VpcId	string	VPC ID.	vpc-0jlx4hol2bjboafzmffvd
HpnZone	string	Cluster zone identifier.	B1
ComputingIpVersion	string	IP version of computing network.	IPv4
Tags	array<object>	Tag information.
	object	Tag.
Key	string	Tag key.	env
Value	string	Tag value.	daily
NextToken	string	Token returned by this call for retrieving next page.	f4f9a292c17072a2

Examples

Success response

JSON format

{
  "RequestId": "2FE2B22C-CF9D-59DE-BF63-DC9B9B33A9D1",
  "Clusters": [
    {
      "Components": "{}",
      "ClusterId": "i137590131672134915401",
      "ClusterName": "cnp_test_cluster",
      "OperatingState": "initializing",
      "TaskId": "i156365121663149566024",
      "ClusterType": "AckEdgePro",
      "NodeCount": 12,
      "NodeGroupCount": 2,
      "CreateTime": "2026-01-27T14:54:02.360",
      "UpdateTime": "2026-01-28T20:56:32.585",
      "ClusterDescription": "测试集群",
      "ResourceGroupId": "rg-aek2ajbjoloa23q",
      "VpcId": "vpc-0jlx4hol2bjboafzmffvd",
      "HpnZone": "B1",
      "ComputingIpVersion": "IPv4",
      "Tags": [
        {
          "Key": "env",
          "Value": "daily"
        }
      ]
    }
  ],
  "NextToken": "f4f9a292c17072a2"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.