Use ListCluster to obtain the cluster list.
Debugging
Request header
This operation only uses common request headers. For more information, see the Common request parameters topic.
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. It is optional. If you do not set this parameter, the system queries the default namespace. For more information about the query ID, see ListUserDefineRegion. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
ClusterList | Array |
Clusters page |
|
Cluster | |||
ClusterId | String | b98b5919-c11**** |
Cluster ID. |
ClusterName | String | cluster-test |
The name of the cluster that was created. |
ClusterType | Integer | 2 |
Cluster Type:
|
Cpu | Integer | 2 |
Total CPU cores |
CpuUsed | Integer | 1 |
The number of CPU cores in use. |
CreateTime | Long | 1502888064561 |
The time when the VSwitch was created. |
CsClusterId | String | c2ce ************ b9203a9 |
The ID of the container service cluster. |
Description | String | Test cluster |
Cluster description |
IaasProvider | String | ALIYUN |
Supplier |
Mem | Integer | 3,072 |
The total memory size. Unit: MB. |
MemUsed | Integer | 200 |
The memory usage. Unit: MB. |
NetworkMode | Integer | 1 |
The network type of the instance. Valid values:
|
NodeNum | Integer | 2 |
Instance quantity. |
OversoldFactor | Integer | 1 |
Docker clusters support the following CPU oversold ratios:
|
RegionId | Boolean | cn-beijing |
The region ID. |
UpdateTime | Long | 1533820823203 |
The last change time. |
VpcId | String | vpc-23727**** |
The ID of the VPC. |
Code | Integer | 200 |
Code. |
Message | String | success |
The message. |
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 code
For a list of error codes, visit the API Error Center.