ListClusters - Alibaba Cloud Linux - Alibaba Cloud Documentation Center

Retrieves all managed clusters for the current user.

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

list

*All Resource

*

None

Request syntax

GET /api/v1/am/cluster/list_clusters HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
current	integer	No	The current page number (starting from page 1).	1
pageSize	integer	No	The number of entries per page.	10
name	string	No	The name of the plug-in used to filter plug-ins.	proxy-next-upstream
cluster_id	string	No	The cluster ID used to filter clusters. Note This cluster ID is not the ACK cluster ID. It is the `id` field returned by this operation.	cb7d4cc26c8f845fb8a8255ffd394820e
cluster_status	string	No	`Running`: The cluster is managed normally. `Installing`: An installation task is in progress for the cluster. `Uninstalling`: An uninstallation task is in progress for the cluster. `Upgrading`: An update task is in progress for the cluster. `Offline`: The cluster is offline and management is abnormal.	Running
cluster_type	string	No	`ACK`: ACK cluster. `CUSTOM`: Custom cluster. The default cluster belongs to the custom cluster type.	ACK
id	string	No	[Deprecated] Use the cluster_id parameter to filter clusters.	cb7d4cc26c8f845fb8a8255ffd394820e

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID, which can be used for end-to-end diagnostics.	B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7
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.	Success
data	array<object>	The returned data.
	object	The returned data.
cluster_id	string	The actual cluster ID. Note For `ACK` clusters, this cluster ID is the ACK cluster ID. For `CUSTOM` clusters, this cluster ID serves as a unique identifier and has no additional meaning.	c666d4774f0e2440b979bf917bf100e40
cluster_status	string	`Running`: The cluster is managed normally. `Installing`: An installation task is in progress for the cluster. `Uninstalling`: An uninstallation task is in progress for the cluster. `Upgrading`: An update task is in progress for the cluster. `Offline`: The cluster is offline and management is abnormal.	Running
cluster_type	string	`ACK`: ACK cluster. `CUSTOM`: Custom cluster. The default cluster belongs to the custom cluster type.	ACK
created_at	string	The creation time.	2024-12-25T15:08:19
id	string	The cluster ID.	5389fba5-92a1-4ff4-9b26-773b97828144
name	string	The cluster name.	auto-name-sbvCT
region	string	The region ID.	cn-hangzhou
updated_at	string	The update time.	2024-12-25T15:08:19
message	string	The error message. If `code == Success`, this field is empty. Otherwise, this field contains the request error information.	success
total	integer	The total number of records.	64

Examples

Success response

JSON format

{
  "RequestId": "B149FD9C-ED5C-5765-B3AD-05AA4A4D64D7",
  "code": "Success",
  "data": [
    {
      "cluster_id": "c666d4774f0e2440b979bf917bf100e40",
      "cluster_status": "Running",
      "cluster_type": "ACK",
      "created_at": "2024-12-25T15:08:19",
      "id": "5389fba5-92a1-4ff4-9b26-773b97828144",
      "name": "auto-name-sbvCT",
      "region": "cn-hangzhou",
      "updated_at": "2024-12-25T15:08:19"
    }
  ],
  "message": "success",
  "total": 64
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.