DocsICP FilingConsole
Documentation
Home Page Intelligent Computing LINGJUN API Reference Lingjun Cluster API (single-tenant version) API catalog Lingjun cluster ListClusters

ListClusters

Updated at:
Copy as MD
Product
My Favorites

Queries 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 None

Request parameters

Parameter

Type

Required

Description

Example
NextToken

string

No

The pagination token. Set this parameter to the value of NextToken that is returned from the previous API call.

a3f2224a5ec7224116c4f5246120abe2
MaxResults

integer

No

The number of entries per page for a paged query. Default value: 20.

20
ResourceGroupId

string

No

The resource group ID.

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

Element

Type

Description

Example

object

RequestId

string

The request ID.

2FE2B22C-CF9D-59DE-BF63-DC9B9B33A9D1
Clusters

array<object>

The cluster information.

array<object>

The cluster object.

Components

any

The component information.

{}
ClusterId

string

The cluster ID.

i137590131672134915401
ClusterName

string

The cluster name.

cnp_test_cluster
OperatingState

string

The cluster status.

Valid values:

  • running :

    Running.

  • expanding :

    Expanding.

  • shrinking :

    Shrinking.

  • initializing :

    Initializing.

initializing
TaskId

string

The task ID.

i156365121663149566024
ClusterType

string

The cluster type.

Valid values:

  • AckEdgePro :

    Lingjun cluster based on ACK@Edge Pro.

  • ExclusiveBareCluster :

    Dedicated bare cluster.

  • Lite :

    Basic edition Lingjun cluster.

AckEdgePro
NodeCount

integer

The number of nodes.

12
NodeGroupCount

integer

The number of node groups.

2
CreateTime

string

The creation time. The time is in ISO 8601 format.

2026-01-27T14:54:02.360
UpdateTime

string

The update time. The time is in ISO 8601 format.

2026-01-28T20:56:32.585
ClusterDescription

string

The cluster description.

Test cluster
ResourceGroupId

string

The resource group ID.

rg-aek2ajbjoloa23q
VpcId

string

The VPC ID.

vpc-0jlx4hol2bjboafzmffvd
HpnZone

string

The cluster number.

B1
ComputingIpVersion

string

The IP version of the computing network.

IPv4
Tags

array<object>

The tag information.

object

The tag information.

Key

string

The tag key.

env
Value

string

The tag value.

daily
NextToken

string

The pagination token 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": "2026-01-27T14:54:02.360",
      "UpdateTime": "2026-01-28T20:56:32.585",
      "ClusterDescription": "Test cluster",
      "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.

Previous：ExtendClusterNext：ListClusterNodes