使用ListCluster获取集群列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求头

该接口使用公共请求头,无特殊请求头。请参见公共请求参数文档。

请求语法

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

请求参数

名称 类型 是否必选 示例值 描述
LogicalRegionId String cn-beijing:test

命名空间的ID,非必填,当不填时会查询默认命名空间。具体ID的查询请参见ListUserDefineRegion

返回数据

名称 类型 示例值 描述
ClusterList Array

集群列表

Cluster
ClusterId String b98b5919-c111-4dad-9f74-7233********

集群ID

ClusterName String cluster-test

集群名称

ClusterType Integer 2

集群类型:

  • 0-普通 Docker 集群
  • 1-Swarm 集群
  • 2-ECS 集群
  • 3-EDAS自建 K8s 集群
  • 4-Pandora 自动注册应用集群类型
  • 5-容器服务 K8s 集群
Cpu Integer 2

总CPU核数

CpuUsed Integer 1

已使用CPU核数

CreateTime Long 1502888064561

创建时间

CsClusterId String c2ce************b9203a9

容器服务集群ID

Description String 测试集群

集群描述

IaasProvider String ALIYUN

供应商

Mem Integer 3072

总内存,单位为MB。

MemUsed Integer 200

已使用内存,单位为MB。

NetworkMode Integer 1

网络类型:

  • 1-经典网络
  • 2-VPC网络
NodeNum Integer 2

实例数量

OversoldFactor Integer 1

Docker集群支持的CPU超卖比率:

  • 2代表1:2比例。
  • 4代表1:4比例。
  • 8代表1:8比例。
RegionId String cn-beijing

地域ID。

UpdateTime Long 1533820823203

最后变更时间。

VpcId String vpc-23727****

专有网络ID。

Code Integer 200

Code返回值。

Message String success

信息。

RequestId String 1053-08e4-47a5-b2ab-5c0323de****

请求ID

示例

请求示例

POST /pop/v5/resource/cluster_list HTTP/1.1
公共请求头

正常返回示例

XML 格式

<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 格式

{
	"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"
			}
		]
	}
}

错误码

访问错误中心查看更多错误码。