全部产品
Search

搜索本产品

    企业级分布式应用服务 EDAS：GetCluster - 获取集群信息

    文档中心

    企业级分布式应用服务 EDAS：GetCluster - 获取集群信息

    更新时间：Mar 01, 2024

    获取指定集群的信息。

    调试

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

    授权信息

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

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    edas:ReadClusterRead
    • Cluster
      acs:edas:{#regionId}:{#accountId}:namespace/{#NameSpaceId}/cluster/{#ClusterId}
      无
    		无

    请求语法

    GET /pop/v5/resource/cluster

    请求参数

    名称类型必填描述示例值
    ClusterIdstring是

    集群 ID。可以通过调用 ListCluster 获取集群 ID，具体操作，请参见 ListCluster 。

    		5439271a-015b-433d-****-d76db49****

    返回参数

    名称类型描述示例值
    object
    Codeinteger

    code 码。

    		200
    Messagestring

    详细信息。

    		success
    RequestIdstring

    请求 ID。

    		d76db491
    Clusterobject

    集群信息。

    VpcIdstring

    VPC 网络 ID。

    		vpc-xxxxz1mlwpb****
    OversoldFactorinteger

    Docker 集群 CPU 超卖：

    • 1：1:1 比例，不超卖。
    • 2：1:2 比例超卖
    • 4：1:4 比例超卖
    • 8：1:8 比例超卖
    		2
    UpdateTimelong

    最后变更时间的时间戳。

    		1570708232145
    MemUsedinteger

    已使用内存量，单位 MB。

    		1024
    IaasProviderstring

    IaaS 资源提供者。

    		ALIYUN
    CreateTimelong

    集群创建时间的时间戳。

    		1570708232145
    CpuUsedinteger

    已使用 CPU 核数。

    		2
    Meminteger

    内存总量，单位为 MB。

    		2048
    RegionIdstring

    地域 ID。

    		cn-hangzhou
    Cpuinteger

    CPU 总核数。

    		4
    CsClusterIdstring

    容器服务集群 ID。

    		c2ce62869f4d4466b920312315f05****
    NetworkModeinteger

    网络类型：

    • 1：经典网络。
    • 2：VPC。
    		2
    Descriptionstring

    描述。

    		测试
    ClusterTypeinteger

    集群类型。

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

    集群名称。

    		ClusterTest
    NodeNuminteger

    ECS 数量。

    		4
    ClusterImportStatusinteger

    导入集群状态。

    • 1：导入成功
    • 2：导入失败
    • 3：正在导入
    • 4：集群已删除
    • 0：未导入
    		0
    ClusterIdstring

    集群 ID。

    		5439271a-015b-433d-befb-d76d****
    SubClusterTypestring

    K8s 类型集群的子类型：ManagedKubernetes 为阿里云 ACK 集群类型， Ask 为阿里云 ASK 集群类型， ExternalKubernetes 为外部集群类型。

    		ManagedKubernetes

    示例

    正常返回示例

    JSON格式

    {
  "Code": 200,
  "Message": "success",
  "RequestId": "d76db491",
  "Cluster": {
    "VpcId": "vpc-xxxxz1mlwpb****",
    "OversoldFactor": 2,
    "UpdateTime": 1570708232145,
    "MemUsed": 1024,
    "IaasProvider": "ALIYUN",
    "CreateTime": 1570708232145,
    "CpuUsed": 2,
    "Mem": 2048,
    "RegionId": "cn-hangzhou",
    "Cpu": 4,
    "CsClusterId": "c2ce62869f4d4466b920312315f05****",
    "NetworkMode": 2,
    "Description": "测试",
    "ClusterType": 2,
    "ClusterName": "ClusterTest",
    "NodeNum": 4,
    "ClusterImportStatus": 0,
    "ClusterId": "5439271a-015b-433d-befb-d76d****",
    "SubClusterType": "ManagedKubernetes"
  }
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2022-06-16OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    出参OpenAPI 返回结构发生变更。