ListCluster - Enterprise Distributed Application Service

Queries clusters.

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

edas:ReadCluster

list

*All Resource

*

None

Request syntax

POST /pop/v5/resource/cluster_list HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
LogicalRegionId	string	No	The ID of the namespace. You can call the ListUserDefineRegion operation to query the namespace ID. For more information, see ListUserDefineRegion. If this parameter is left empty, the clusters in the default namespace are queried. If this parameter is specified, the clusters in the specified namespace are queried.	cn-beijing:test
ResourceGroupId	string	No	The ID of the resource group. You can call the ListResourceGroup operation to query the resource group ID. For more information, see ListResourceGroup. If this parameter is left empty, the clusters in the default resource group are queried. If this parameter is specified, the clusters in the specified resource group are queried.	461

Response elements

Element	Type	Description	Example
	object
Code	integer	The HTTP status code that is returned.	200
Message	string	The additional information that is returned.	success
RequestId	string	The ID of the request.	1053-08e4-47a5-b2ab-5c0323de****
ClusterList	object
Cluster	array<object>	The clusters.
	object
VpcId	string	VPC ID	vpc-23727****
OversoldFactor	integer	The CPU overcommit ratio that is supported by a Docker cluster. Valid values: 1: 1:1, which means that CPU resources are not overcommitted. 2: 1:2, which means that CPU resources are overcommitted by 1:2. 4: 1:4, which means that CPU resources are overcommitted by 1:4. 8: 1:8, which means that CPU resources are overcommitted by 1:8.	1
UpdateTime	integer	The timestamp when the cluster was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1533820823203
MemUsed	integer	The size of used memory. Unit: MB.	200
IaasProvider	string	The provider of the cluster.	ALIYUN
CreateTime	integer	The timestamp when the cluster was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1502888064561
CpuUsed	integer	The number of used CPU cores.	1
Mem	integer	The total size of memory. Unit: MB.	3072
RegionId	string	The ID of the region.	cn-beijing
Cpu	integer	The total number of CPU cores.	2
CsClusterId	string	The ID of the cluster in Container Service for Kubernetes (ACK).	c2ce************b9203a9
NetworkMode	integer	The network type of the cluster. Valid values: 1: classic network 2: virtual private cloud (VPC)	1
Description	string	The description of the cluster.	测试集群
ClusterType	integer	The type of the cluster. Valid values: 0: regular Docker cluster 1: Swarm cluster 2: Elastic Compute Service (ECS) cluster 3: self-managed Kubernetes cluster in Enterprise Distributed Application Service (EDAS) 4: cluster in which Pandora automatically registers applications 5: ACK cluster	2
ResourceGroupId	string	The ID of the resource group.	461
ClusterName	string	The name of the cluster.	cluster-test
NodeNum	integer	The number of instances.	2
ClusterId	string	The ID of the cluster in EDAS.	b98b5919-c111-4dad-9f74-7233********

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "success",
  "RequestId": "1053-08e4-47a5-b2ab-5c0323de****",
  "ClusterList": {
    "Cluster": [
      {
        "VpcId": "vpc-23727****",
        "OversoldFactor": 1,
        "UpdateTime": 1533820823203,
        "MemUsed": 200,
        "IaasProvider": "ALIYUN",
        "CreateTime": 1502888064561,
        "CpuUsed": 1,
        "Mem": 3072,
        "RegionId": "cn-beijing",
        "Cpu": 2,
        "CsClusterId": "c2ce************b9203a9",
        "NetworkMode": 1,
        "Description": "测试集群",
        "ClusterType": 2,
        "ResourceGroupId": "461",
        "ClusterName": "cluster-test",
        "NodeNum": 2,
        "ClusterId": "b98b5919-c111-4dad-9f74-7233********"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.