ListCluster - Enterprise Distributed Application Service

Queries clusters.

Authorization information

There is currently no authorization information disclosed in the API.

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. If this parameter is not specified, 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. If this parameter is not specified, 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 parameters

Parameter	Type	Description	Example
	object
Code	integer	The HTTP status code returned.	200
Message	string	The message returned.	success
RequestId	string	The ID of the request.	1053-08e4-47a5-b2ab-5c0323de****
ClusterList	array	The information about clusters.
	object
VpcId	string	VPC ID	vpc-23727****
OversoldFactor	integer	The CPU oversold ratio supported by a Docker cluster. Valid values: 1: 1:1, which indicates that resources are not oversold. 2: 1:2, which indicates that resources are oversold by 1:2. 4: 1:4, which indicates that resources are oversold by 1:4. 8: 1:8, which indicates that resources are oversold by 1:8.	1
UpdateTime	long	The time 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	long	The time 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 region ID of the cluster.	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.	Test
ClusterType	integer	The type of the cluster. Valid values: 0: a regular Docker cluster 1: a Swarm cluster 2: an Elastic Compute Service (ECS) cluster 3: a self-managed Kubernetes cluster in Enterprise Distributed Application Service (EDAS) 4: a cluster in which Pandora automatically registers applications 5: an 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 nodes in the cluster.	2
ClusterId	string	The ID of the cluster in EDAS.	b98b5919-c111-4dad-9f74-7233********

Examples

Sample success responses

JSONformat

{
  "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": "Test",
        "ClusterType": 2,
        "ResourceGroupId": "461",
        "ClusterName": "cluster-test",
        "NodeNum": 2,
        "ClusterId": "b98b5919-c111-4dad-9f74-7233********"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.