调用ListCluster接口获取集群列表。

调试

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

请求头

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

请求语法

POST /pop/v5/resource/cluster_list HTTP/1.1

请求参数

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

命名空间的ID。查询命名空间ID,请参见ListUserDefineRegion

  • 未设置该参数,则查询默认命名空间的集群列表。
  • 设置该参数,则查询指定命名空间的集群列表。
ResourceGroupId String Query 461

资源组ID。查询资源组ID,请参见ListResourceGroup

  • 未设置该参数,则查询默认资源组的集群列表。
  • 设置该参数,则查询指定资源组的集群列表。

返回数据

名称 类型 示例值 描述
ClusterList Array of Cluster

集群列表

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

EDAS中的集群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

容器服务Kubernetes版中创建的K8s集群的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超卖比例。

  • 1:1:1比例,不超卖
  • 2:1:2比例
  • 4:1:4比例
  • 8:1:8比例
RegionId String cn-beijing

地域ID

ResourceGroupId String 461

资源组ID

UpdateTime Long 1533820823203

最后变更时间的时间戳

VpcId String vpc-23727****

VPC ID

Code Integer 200

接口状态或POP错误码

Message String success

附加信息

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

请求ID

示例

请求示例

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

正常返回示例

XML格式

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

JSON格式

{
    "ClusterList": {
        "Cluster": {
            "OversoldFactor": 1,
            "Description": "测试集群",
            "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
}