Queries clusters.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request headers

This operation uses common request headers, but does not use special request headers. For more information, see Common parameters.

Request syntax

POST /pop/v5/resource/cluster_list HTTPS|HTTP

Request parameters

Parameter Type Required Example Description
LogicalRegionId String No cn-beijing:test

The ID of the namespace. This parameter is optional. When this parameter is not specified, the default namespace is queried. For more information about how to query a namespace ID, see ListUserDefineRegion.

Response parameters

Parameter Type Example Description
ClusterList Array of Cluster

The list of clusters.
Cluster
ClusterId String b98b5919-c111-4dad-9f74-7233********

The ID of the cluster.
ClusterName String cluster-test

The name of the cluster.
ClusterType Integer 2

The type of the cluster. Valid values:

  • 0: normal Docker clusters
  • 1: Swarm clusters
  • 2: Elastic Compute Service (ECS) clusters
  • 3: user-created Kubernetes clusters in EDAS
  • 4: Pandora clusters that automatically register applications (obsolete)
  • 5: Container Service Kubernetes clusters
Cpu Integer 2

The total number of CPU cores.
CpuUsed Integer 1

The number of used CPU cores.
CreateTime Long 1502888064561

The time when the cluster was created.
CsClusterId String c2ce************b9203a9

The ID generated for the cluster in the Container Service for Kubernetes console.
Description String Test instance

The description of the cluster.
IaasProvider String ALIYUN

The service provider of the cluster.
Mem Integer 3072

The total memory size. Unit: MB.
MemUsed Integer 200

The used memory size. Unit: MB.
NetworkMode Integer 1

The network type. Valid values:

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

The number of instances.
OversoldFactor Integer 1

The CPU overcommitment ratio supported by normal Docker clusters. Valid values:

  • 2: 1:2
  • 4: 1:4
  • 8: 1:8
RegionId String cn-beijing

The ID of the region.
UpdateTime Long 1533820823203

The time when the cluster was last updated.
VpcId String vpc-23727****

The ID of the VPC.
Code Integer 200

The HTTP status code returned for the request.
Message String success

The additional information.
RequestId String 1053-08e4-47a5-b2ab-5c0323de****

The ID of the request.

Examples

Sample requests

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

Sample success responses

XML format 

<Message>success</Message>
<Code>200</Code>
<ClusterList>
    <Cluster>
        <MemUsed>0</MemUsed>
        <Mem>0</Mem>
        <NetworkMode>2</NetworkMode>
        <UpdateTime>1557986815279</UpdateTime>
        <NodeNum>0</NodeNum>
        <VpcId>vpc-2zes5h7bxyq6se8ms****</VpcId>
        <OversoldFactor>1</OversoldFactor>
        <Cpu>0</Cpu>
        <ClusterId>0239e972-fbcd-40d5-914c-47dbc49b****</ClusterId>
        <ClusterName>doc-test</ClusterName>
        <CsClusterId>c2ce62869f4d4466b920312315f05****</CsClusterId>
        <RegionId>cn-beijing</RegionId>
        <CreateTime>1557985562153</CreateTime>
        <CpuUsed>0</CpuUsed>
        <ClusterType>2</ClusterType>
        <IaasProvider>ALIYUN</IaasProvider>
    </Cluster>
    <Cluster>
        <MemUsed>0</MemUsed>
        <Mem>24576</Mem>
        <NetworkMode>2</NetworkMode>
        <UpdateTime>1569675703492</UpdateTime>
        <NodeNum>3</NodeNum>
        <VpcId>vpc-2ze9sywarkrp0xh3d****</VpcId>
        <OversoldFactor>1</OversoldFactor>
        <Cpu>12</Cpu>
        <ClusterId>135c1bc1231706e3e37ffbdb29f97cd8502e****</ClusterId>
        <ClusterName>CN-BEIJING_vpc-2ze9sywarkrp0xh3d****_DEFAULT</ClusterName>
        <CsClusterId>c2ce62869f4d4466b920312315f05****</CsClusterId>
        <RegionId>cn-beijing</RegionId>
        <CreateTime>1569674543528</CreateTime>
        <CpuUsed>0</CpuUsed>
        <ClusterType>2</ClusterType>
        <IaasProvider>ALIYUN</IaasProvider>
    </Cluster>
    <Cluster>
        <MemUsed>0</MemUsed>
        <Mem>0</Mem>
        <NetworkMode>2</NetworkMode>
        <UpdateTime>1544687276905</UpdateTime>
        <NodeNum>0</NodeNum>
        <VpcId>vpc-2ze20lsdud3qooqec****</VpcId>
        <OversoldFactor>1</OversoldFactor>
        <Cpu>0</Cpu>
        <ClusterId>162f5a6c6a5fb584995490110c0ecab49666****</ClusterId>
        <ClusterName>CN-BEIJING_vpc-2ze20lsdud3qooqec****_DEFAULT</ClusterName>
        <RegionId>cn-beijing</RegionId>
        <CreateTime>1536641525211</CreateTime>
        <CpuUsed>0</CpuUsed>
        <ClusterType>2</ClusterType>
        <IaasProvider>ALIYUN</IaasProvider>
    </Cluster>
    <Cluster>
        <MemUsed>0</MemUsed>
        <Mem>0</Mem>
        <NetworkMode>2</NetworkMode>
        <UpdateTime>1570850383830</UpdateTime>
        <NodeNum>0</NodeNum>
        <VpcId>vpc-2zecvqz8ri0s0nqog****</VpcId>
        <OversoldFactor>1</OversoldFactor>
        <Cpu>0</Cpu>
        <ClusterId>841ca2d486e7451f996b74c758e5c6b4c13b****</ClusterId>
        <ClusterName>CN-BEIJING_vpc-2zecvqz8ri0s0nqog****_DEFAULT</ClusterName>
        <RegionId>cn-beijing</RegionId>
        <CreateTime>1570850336816</CreateTime>
        <CpuUsed>0</CpuUsed>
        <ClusterType>2</ClusterType>
        <IaasProvider>ALIYUN</IaasProvider>
    </Cluster>
</ClusterList>

JSON format 

{
	"Message": "success",
	"Code": 200,
	"ClusterList": {
		"Cluster": [
			{
				"MemUsed": 0,
				"Mem": 0,
				"NetworkMode": 2,
				"UpdateTime": 1557986815279,
				"NodeNum": 0,
				"VpcId": "vpc-2zes5h7bxyq6se8ms****",
				"OversoldFactor": 1,
				"Cpu": 0,
				"ClusterId": "0239e972-fbcd-40d5-914c-47dbc49b****",
				"ClusterName": "doc-test",
                "CsClusterId": "c2ce62869f4d4466b920312315f05****",
				"RegionId": "cn-beijing",
				"CreateTime": 1557985562153,
				"CpuUsed": 0,
				"ClusterType": 2,
				"IaasProvider": "ALIYUN"
			},
			{
				"MemUsed": 0,
				"Mem": 24576,
				"NetworkMode": 2,
				"UpdateTime": 1569675703492,
				"NodeNum": 3,
				"VpcId": "vpc-2ze9sywarkrp0xh3d****",
				"OversoldFactor": 1,
				"Cpu": 12,
				"ClusterId": "135c1bc1231706e3e37ffbdb29f97cd8502e****",
				"ClusterName": "CN-BEIJING_vpc-2ze9sywarkrp0xh3d****_DEFAULT",
				"CsClusterId": "c2ce62869f4d4466b920312315f05****",
                "RegionId": "cn-beijing",
				"CreateTime": 1569674543528,
				"CpuUsed": 0,
				"ClusterType": 2,
				"IaasProvider": "ALIYUN"
			},
			{
				"MemUsed": 0,
				"Mem": 0,
				"NetworkMode": 2,
				"UpdateTime": 1544687276905,
				"NodeNum": 0,
				"VpcId": "vpc-2ze20lsdud3qooqec****",
				"OversoldFactor": 1,
				"Cpu": 0,
				"ClusterId": "162f5a6c6a5fb584995490110c0ecab49666****",
				"ClusterName": "CN-BEIJING_vpc-2ze20lsdud3qooqec****_DEFAULT",
				"RegionId": "cn-beijing",
				"CreateTime": 1536641525211,
				"CpuUsed": 0,
				"ClusterType": 2,
				"IaasProvider": "ALIYUN"
			},
			{
				"MemUsed": 0,
				"Mem": 0,
				"NetworkMode": 2,
				"UpdateTime": 1570850383830,
				"NodeNum": 0,
				"VpcId": "vpc-2zecvqz8ri0s0nqog****",
				"OversoldFactor": 1,
				"Cpu": 0,
				"ClusterId": "841ca2d486e7451f996b74c758e5c6b4c13b****",
				"ClusterName": "CN-BEIJING_vpc-2zecvqz8ri0s0nqog****_DEFAULT",
				"RegionId": "cn-beijing",
				"CreateTime": 1570850336816,
				"CpuUsed": 0,
				"ClusterType": 2,
				"IaasProvider": "ALIYUN"
			}
		]
	}
}

Error codes

For a list of error codes, visit the API Error Center.