ListCluster - 获取集群列表 - 企业级分布式应用服务 EDAS

获取集群列表。

调试

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

授权信息

当前API暂无授权信息透出。

请求语法

POST /pop/v5/resource/cluster_list

请求参数

名称	类型	必填	描述	示例值
LogicalRegionId	string	否	命名空间的 ID。查询命名空间 ID，请参见 ListUserDefineRegion 。未设置该参数，则查询默认命名空间的集群列表。设置该参数，则查询指定命名空间的集群列表。	cn-beijing:test
ResourceGroupId	string	否	资源组 ID。查询资源组 ID，请参见 ListResourceGroup 。未设置该参数，则查询默认资源组的集群列表。设置该参数，则查询指定资源组的集群列表。	461

返回参数

名称	类型	描述	示例值
	object
Code	integer	接口状态或 POP 错误码	200
Message	string	附加信息	success
RequestId	string	请求 ID	1053-08e4-47a5-b2ab-5c0323de****
ClusterList	object []	集群列表
VpcId	string	VPC ID	vpc-23727****
OversoldFactor	integer	Docker 集群支持的 CPU 超卖比例。 1：1:1 比例，不超卖 2：1:2 比例 4：1:4 比例 8：1:8 比例	1
UpdateTime	long	最后变更时间的时间戳	1533820823203
MemUsed	integer	已使用内存，单位为 MB。	200
IaasProvider	string	集群供应商	ALIYUN
CreateTime	long	创建时间的时间戳	1502888064561
CpuUsed	integer	已使用 CPU 核数	1
Mem	integer	总内存，单位为 MB。	3072
RegionId	string	地域 ID	cn-beijing
Cpu	integer	总 CPU 核数	2
CsClusterId	string	容器服务 Kubernetes 版中创建的 K8s 集群的 ID	c2ce************b9203a9
NetworkMode	integer	网络类型。 1：经典网络 2：VPC	1
Description	string	集群描述	测试集群
ClusterType	integer	集群类型。 0：普通 Docker 集群 1：Swarm 集群 2：ECS 集群 3：EDAS 自建 K8s 集群 4：Pandora 自动注册应用集群 5：容器服务 K8s 集群	2
ResourceGroupId	string	资源组 ID	461
ClusterName	string	集群名称	cluster-test
NodeNum	integer	实例数量	2
ClusterId	string	EDAS 中的集群 ID	b98b5919-c111-4dad-9f74-7233********

示例

正常返回示例

JSON格式

{
  "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": "测试集群",
        "ClusterType": 2,
        "ResourceGroupId": "461",
        "ClusterName": "cluster-test",
        "NodeNum": 2,
        "ClusterId": "b98b5919-c111-4dad-9f74-7233********"
      }
    ]
  }
}

JSON格式

{
  "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": "测试集群",
        "ClusterType": 2,
        "ResourceGroupId": "461",
        "ClusterName": "cluster-test",
        "NodeNum": 2,
        "ClusterId": "b98b5919-c111-4dad-9f74-7233********"
      }
    ]
  }
}

错误码

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

变更历史

变更时间	变更内容概要	操作

暂无变更历史