All Products
Search
Document Center

Enterprise Distributed Application Service:ListCluster

Last Updated:May 12, 2023

Queries clusters.

Authorization information

There is currently no authorization information disclosed in the API.

Request syntax

POST /pop/v5/resource/cluster_list

Request parameters

ParameterTypeRequiredDescriptionExample
LogicalRegionIdstringNo

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.
cn-beijing:test
ResourceGroupIdstringNo

The HTTP status code returned.

461

Response parameters

ParameterTypeDescriptionExample
object
Codeinteger

The message returned.

200
Messagestring

The ID of the request.

success
RequestIdstring

The information about clusters.

1053-08e4-47a5-b2ab-5c0323de****
ClusterListarray

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.
object
VpcIdstring

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.

vpc-23727****
OversoldFactorinteger

The size of used memory. Unit: MB.

1
UpdateTimelong

The provider of the cluster.

1533820823203
MemUsedinteger

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.

200
IaasProviderstring

The number of used CPU cores.

ALIYUN
CreateTimelong

The total size of memory. Unit: MB.

1502888064561
CpuUsedinteger

The region ID of the cluster.

1
Meminteger

The total number of CPU cores.

3072
RegionIdstring

The ID of the cluster in Container Service for Kubernetes (ACK).

cn-beijing
Cpuinteger

The network type of the cluster. Valid values:

  • 1: classic network
  • 2: virtual private cloud (VPC)
2
CsClusterIdstring

The description of the cluster.

c2ce************b9203a9
NetworkModeinteger

Test

1
Descriptionstring

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
The ID of the resource group.
ClusterTypeinteger

The name of the cluster.

2
ResourceGroupIdstring

The number of nodes in the cluster.

461
ClusterNamestring

The ID of the cluster in EDAS.

cluster-test
NodeNuminteger

POST /pop/v5/resource/cluster_list HTTP/1.1 Common request headers

2
ClusterIdstring

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

b98b5919-c111-4dad-9f74-7233********

Error codes

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