All Products
Search
Document Center

Enterprise Distributed Application Service:ListCluster

Last Updated:Jan 08, 2024

Queries clusters.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

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 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
ResourceGroupIdstringNo

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 parameters

ParameterTypeDescriptionExample
object
Codeinteger

The HTTP status code that is returned.

200
Messagestring

The additional information that is returned.

success
RequestIdstring

The ID of the request.

1053-08e4-47a5-b2ab-5c0323de****
ClusterListobject []

The clusters.

VpcIdstring

VPC ID

vpc-23727****
OversoldFactorinteger

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
UpdateTimelong

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
MemUsedinteger

The size of used memory. Unit: MB.

200
IaasProviderstring

The provider of the cluster.

ALIYUN
CreateTimelong

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
CpuUsedinteger

The number of used CPU cores.

1
Meminteger

The total size of memory. Unit: MB.

3072
RegionIdstring

The ID of the region.

cn-beijing
Cpuinteger

The total number of CPU cores.

2
CsClusterIdstring

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

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

The network type of the cluster. Valid values:

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

The description of the cluster.

Test
ClusterTypeinteger

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
ResourceGroupIdstring

The ID of the resource group.

461
ClusterNamestring

The name of the cluster.

cluster-test
NodeNuminteger

The number of instances.

2
ClusterIdstring

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\n",
        "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.