All Products
Document Center


Last Updated: Nov 16, 2018


Returns a cluster list.

Request URL


Request method


Request parameters

Parameter Type Required? Description
logicalRegionId String No Logical region ID corresponding to the namespace. This parameter is optional and its value can be obtained by the ListUserDefineRegionRequest API. If it is not set, the query is implemented in the default namespace.

Response parameters

Parameter Type Description
Code Integer Code
Message String Message
ClusterList List<Cluster> A list of cluster entities


Parameter Type Description
ClusterId String Cluster ID
RegionId String ID of the logical region
Description String Cluster description
ClusterName String Cluster name
ClusterType Integer Cluster type.Optional values: 1 (Swarm cluster); 2 (ECS cluster); 3 (Kubernetes cluster).
OversoldFactor Integer CPU overselling of the Docker cluster.Optional values: 2 (1:2); 4 (1:4); 8 (1:8).
NetworkMode Integer Network type.Optional values: 1 (classic network); 2 (VPC).
VpcId String VPC ID
NodeNum Integer Number of ECS instances
Cpu Integer Total number of CPU cores
Mem Integer Total memory, in MB
CpuUsed Integer Number of used CPU cores
MemUsed Integer Used memory, in MB
CreateTime Integer Creation time
UpdateTime Integer Last change time