ListClusters - Platform For AI - Alibaba Cloud Documentation Center

Retrieves a list of cluster instances.

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	The token that is used to retrieve the next page of results. Set this parameter to the NextToken value that is returned in the last response.	a3f2224a5ec7224116c4f5246120abe2
MaxResults	integer	No	The number of entries to return on each page. Default value: 20.	20
ResourceGroupId	string	No	The ID of the resource group.	rg-aek2bg6wyoox6jq
Tags	array<object>	No	The list of tags.
	object	No	The tag object.
Key	string	No	The tag key.	my_key
Value	string	No	The tag value.	my_value

Response elements

Parameter	Type	Description	Example
	object
RequestId	string	The ID of the request.	2FE2B22C-CF9D-59DE-BF63-DC9B9B33A9D1
Clusters	array<object>	The information about the clusters.
	object	The cluster object.
Components	any	The information about the components.	{}
ClusterId	string	The ID of the cluster.	i137590131672134915401
ClusterName	string	The name of the cluster.	cnp_test_cluster
OperatingState	string	The status of the cluster.	initializing
TaskId	string	The ID of the task.	i156365121663149566024
ClusterType	string	The type of the cluster.	AckEdgePro
NodeCount	integer	The number of nodes.	12
NodeGroupCount	integer	The number of node groups.	2
CreateTime	string	The time when the cluster was created.	1672134938
UpdateTime	string	The time when the cluster was last updated.	1672134968
ClusterDescription	string	The description of the cluster.	测试集群
ResourceGroupId	string	The ID of the resource group.	rg-aek2ajbjoloa23q
VpcId	string	The ID of the virtual private cloud (VPC).	vpc-0jlx4hol2bjboafzmffvd
HpnZone	string	The cluster number.	B1
ComputingIpVersion	string	The IP version of the computing network.	IPv4
Tags	array<object>	The information about the tags.
	object	The tag information.
Key	string	The tag key.	env
Value	string	The tag value.	daily
NextToken	string	The query token value returned by this call.	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": "1672134938",
      "UpdateTime": "1672134968",
      "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.