ListCluster - 获取集群列表

获取集群列表。

调试

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

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

edas:ReadCluster

list

*全部资源

*

请求语法

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

请求参数

名称

类型

必填

描述

示例值

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

Cluster

array<object>

集群列表

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

integer

最后变更时间的时间戳

1533820823203

MemUsed

integer

已使用内存,单位为 MB。

200

IaasProvider

string

集群供应商

ALIYUN

CreateTime

integer

创建时间的时间戳

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

错误码

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

变更历史

更多信息,参考变更详情