文档首页 > > API参考> API> 集群管理> 获取指定项目下的集群

获取指定项目下的集群

分享
更新时间:2020/10/10 GMT+08:00

功能介绍

该API用于获取指定项目下所有集群的详细信息。

调试

您可以在API Explorer中调试该接口。

URI

GET /api/v3/projects/{project_id}/clusters

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方式请参见如何获取接口URI中参数

表2 Query参数

参数

是否必选

参数类型

描述

errorStatus

String

集群状态兼容Error参数,用于API平滑切换。 兼容场景下,errorStatus为空则屏蔽Error状态为Deleting状态。

最小长度:0

最大长度:10

detail

String

查询集群详细信息。若设置为true,获取集群下节点总数(totalNodesNumber)、正常节点数(activeNodesNumber)、CPU总量(totalNodesCPU)、内存总量(totalNodesMemory)和已安装插件名称(installedAddonInstances),放入到annotation中。

status

String

集群状态,取值如下

  • Available:可用,表示集群处于正常状态。

  • Unavailable:不可用,表示集群异常,需手动删除或联系管理员删除。

  • ScalingUp:扩容中,表示集群正处于扩容过程中。

  • ScalingDown:缩容中,表示集群正处于缩容过程中。

  • Creating:创建中,表示集群正处于创建过程中。

  • Deleting:删除中,表示集群正处于删除过程中。

  • Upgrading:升级中,表示集群正处于升级过程中。

  • Resizing:规格变更中,表示集群正处于变更规格中。

  • Empty:集群无任何资源

枚举值:

  • Available

  • Unavailable

  • ScalingUp

  • ScalingDown

  • Creating

  • Deleting

  • Upgrading

  • Resizing

  • Empty

type

String

集群类型:

  • VirtualMachine:混合集群

  • BareMetal:裸金属集群

  • ARM64:鲲鹏集群

缺省值:VirtualMachine,BareMetal,ARM64

枚举值:

  • VirtualMachine

  • BareMetal

  • ARM64

version

String

集群版本过滤

最小长度:0

最大长度:20

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

消息体的类型(格式)

枚举值:

  • application/json;charset=utf-8

  • application/json

X-Auth-Token

String

调用接口的认证方式分为Token和AK/SK两种,如果您使用的Token方式,此参数为必填,请填写Token的值,获取方式请参见获取token

最大长度:16384

响应参数

状态码为 200 时:

表4 响应Body参数

参数

参数类型

描述

kind

String

Api type

缺省值:Cluster

最小长度:6

最大长度:10

apiVersion

String

API version

缺省值:v3

最小长度:2

最大长度:5

items

Array of V3Cluster objects

集群对象列表,包含了当前项目下所有集群的详细信息。您可通过items.metadata.name下的值来找到对应的集群。

表5 V3Cluster

参数

参数类型

描述

kind

String

API类型,固定值“Cluster”或“cluster”,该值不可修改。

缺省值:Cluster

apiVersion

String

API版本,固定值“v3”,该值不可修改。

缺省值:v3

metadata

ClusterMetadata object

集群的基本信息,为集合类的元素类型,包含一组由不同名称定义的属性。

spec

V3ClusterSpec object

spec是集合类的元素类型,您对需要管理的集群对象进行详细描述的主体部分都在spec中给出。CCE通过spec的描述来创建或更新对象。

status

ClusterStatus object

集合类的元素类型,用于记录对象在系统中的当前状态信息,包含了集群状态和本次创建集群作业的jobID

表6 ClusterMetadata

参数

参数类型

描述

name

String

集群名称。

命名规则:以小写字母开头,由小写字母、数字、中划线(-)组成,长度范围4-128位,且不能以中划线(-)结尾。

最小长度:4

最大长度:128

uid

String

资源唯一标识,创建成功后自动生成,填写无效

annotations

Map<String,String>

集群注解,由key/value组成:

"annotations": {
   "key1" : "value1",
   "key2" : "value2"
}
说明:

Annotations不用于标识和选择对象。Annotations中的元数据可以是small 或large,structured 或unstructured,并且可以包括标签不允许使用的字符。 该字段不会被数据库保存,当前仅用于指定集群待安装插件。

labels

Map<String,String>

集群标签,key/value对格式。

说明:

该字段值由系统自动生成,用于升级时前端识别集群支持的特性开关,用户指定无效。

creationTimestamp

String

集群创建时间

updateTimestamp

String

集群更新时间

表7 V3ClusterSpec

参数

参数类型

描述

type

String

集群类型:

  • VirtualMachine:混合集群

基于Kubernetes来管理一组节点资源,支持虚拟机和裸金属的管理,Kubernetes将自动调度容器运行在可用节点上。在创建容器工作负载前,您需要存在一个可用集群。

  • BareMetal:裸金属集群

基于裸金属服务提供高计算和高网络性能的kubernetes容器集群,如需使用,请创建裸金属服务器。裸金属集群为保证高速的容器网络性能,要求您在创建裸金属服务器时,添加一块高速网卡。添加步骤请参见管理高速网络

  • ARM64: 鲲鹏集群

鲲鹏容器集群(ARM指令集)提供了容器在鲲鹏(ARM架构)服务器上的运行能力,提供与X86服务器相同的调度伸缩和快速部署能力。

枚举值:

  • VirtualMachine

  • BareMetal

  • ARM64

flavor

String

字段默认值:

  • 创建混合集群或鲲鹏集群时,如果是非专属云为 cce.s1.small,专属云则为 cce.dec.s1.small;

  • 创建其他集群时如果是非专属云为 cce.t1.small,专属云则为 cce.dec.t1.small。

集群规格,集群创建完成后规格不可再变更,请按实际业务需求进行选择。

cce.s1.small: 小规模单控制节点混合集群(最大50节点)

cce.s1.medium: 中等规模单控制节点混合集群(最大200节点)

cce.s1.large: 大规模单控制节点混合集群(最大1000节点)

cce.t1.small: 小规模单控制节点裸金属集群(最大10节点)

cce.t1.medium: 中等规模单控制节点裸金属集群(最大100节点)

cce.t1.large: 大规模单控制节点裸金属集群(最大500节点)

cce.s2.small: 小规模高可用混合集群(最大50节点)

cce.s2.medium: 中等规模高可用混合集群(最大200节点)

cce.s2.large: 大规模高可用混合集群(最大1000节点)

cce.t2.small: 小规模高可用裸金属集群(最大10节点)

cce.t2.medium: 中等规模高可用裸金属集群(最大100节点)

cce.t2.large: 大规模高可用裸金属集群(最大500节点)

说明:

s1:单控制节点混合集群。

s2:高可用混合集群。

t1:单控制节点裸金属集群。

t2:高可用裸金属集群。

dec:专属混合集群规格。如cce.dec.s1.small为小规模单控制节点专属混合集群(最大50节点)。

最大节点数:当前集群支持管理的最大节点规模,请根据业务需求选择。

单控制节点集群:普通集群是单控制节点,控制节点故障后,集群将不可用,但已运行工作负载不受影响。

高可用集群:高可用集群是多控制节点,单控制节点故障,集群仍然可用。查看集群模式请参见如何排查已创建的集群是否为高可用集群?

version

String

集群版本,与Kubernetes社区基线版本保持一致,建议选择最新版本。

在CCE控制台中支持创建两种最新版本的集群。可登录CCE控制台,单击“总览 > 购买Kubernetes集群”,在“版本”处获取到集群版本。 其它集群版本,当前仍可通过api创建,但后续会逐渐下线,具体下线策略请关注CCE官方公告。

说明:
  • 若不配置,默认创建最新版本的集群。

  • 若指定集群基线版本但是不指定具体r版本,则系统默认选择对应集群版本的最新r版本。建议不指定具体r版本由系统选择最新版本。

description

String

集群描述,对于集群使用目的的描述,可根据实际情况自定义,默认为空。集群创建成功后可通过接口更新指定的集群来做出修改,也可在CCE控制台中对应集群的“集群详情”下的“描述”处进行修改。仅支持utf-8编码。

最小长度:0

最大长度:200

ipv6enable

Boolean

集群是否使用IPv6模式,1.15版本及以上支持。

hostNetwork

HostNetwork object

节点网络参数,包含了虚拟私有云VPC和子网的ID信息,而VPC是集群内节点之间的通信依赖,所以是必选的参数集。

containerNetwork

ContainerNetwork object

容器网络参数,包含了容器网络类型和容器网段的信息。

eniNetwork

ENINetwork object

Yangtse网络配置,创建CCE Turbo集群(公测中)时指定。

authentication

Authentication object

集群认证方式相关配置。

billingMode

Integer

集群的计费方式,当前接口只支持创建“按需计费”的集群。计费方式为“按需计费”时,取值为“0”。若不填,则默认为“0”。

缺省值:0

masters

Array of MasterSpec objects

控制节点的高级配置

kubernetesSvcIpRange

String

服务网段参数,kubernetes clusterIp取值范围,1.11.7版本及以上支持。

clusterTags

Array of ResourceTag objects

集群资源标签

kubeProxyMode

String

服务转发模式,支持以下两种实现:

iptables:社区传统的kube-proxy模式,完全以iptables规则的方式来实现service负载均衡。该方式最主要的问题是在服务多的时候产生太多的iptables规则,非增量式更新会引入一定的时延,大规模情况下有明显的性能问题。

ipvs:主导开发并在社区获得广泛支持的kube-proxy模式,采用增量式更新,吞吐更高,速度更快,并可以保证service更新期间连接保持不断开,适用于大规模场景。

说明:

此参数目前仅在响应中体现,创建集群时请在extendParam中配置此参数。

枚举值:

  • iptables

  • ipvs

az

String

可用区(仅查询返回字段)

extendParam

Map<String,String>

扩展字段,key/value对格式。可配置多可用区集群、专属混合集群,以及将集群创建在特定的企业项目下。可配置的key/value对如下:

  • clusterAZ: 集群控制节点可用区配置。

    • multi_az:多可用区,可选。仅使用高可用集群时才可以配置多可用区。

    • 专属云计算池可用区:用于指定专属云可用区部署集群控制节点。 如果需配置专属混合集群,该字段为必选。例如“华北四-可用区一”取值为:cn-north-4a。更多信息请参见什么是专属计算集群?

  • dssMasterVolumes: 用于指定控制节点的系统盘和数据盘使用专属分布式存储,未指定或者值为空时,默认使用EVS云硬盘。 如果配置专属混合集群,该字段为必选,请按照如下格式设置:

    <rootVol.dssPoolID>.<rootVol.volType>;<dataVol.dssPoolID>.<dataVol.volType>

    字段说明: rootVol为系统盘;dataVol为数据盘; dssPoolID为专属分布式存储池ID; volType为专属分布式存储池的存储类型,如SAS、SSD。 样例:c950ee97-587c-4f24-8a74-3367e3da570f.sas;6edbc2f4-1507-44f8-ac0d-eed1d2608d38.ssd 非专属混合集群不支持配置该字段。

  • enterpriseProjectId: 如果需要将集群创建在特定的企业项目下,请设置{"enterpriseProjectId":"xxx"}的key/value对。

    说明:
    • 需要开通企业项目功能后才可配置企业项目,详情请参见 如何进入企业管理页面

    • 集群所属的企业项目与集群下所关联的其他云服务资源所属的企业项目必须保持一致。

  • kubeProxyMode: 服务转发模式,支持以下两种实现:

    • iptables:社区传统的kube-proxy模式,完全以iptables规则的方式来实现service负载均衡。该方式最主要的问题是在服务多的时候产生太多的iptables规则,非增量式更新会引入一定的时延,大规模情况下有明显的性能问题

    • ipvs:主导开发并在社区获得广泛支持的kube-proxy模式,采用增量式更新,吞吐更高,速度更快,并可以保证service更新期间连接保持不断开,适用于大规模场景。

  • clusterExternalIP: master 弹性公网IP

  • alpha.cce/fixPoolMask: 容器网络固定IP池掩码位数,仅vpc-router支持。 整数字符传取值范围: 24 ~ 28

  • decMasterFlavor: 专属混合集群指定可控制节点的规格。最大长度255。

  • dockerUmaskMode: 集群默认Docker的UmaskMode配置,可取值为secure或normal,不指定时默认为normal。

  • kubernetes.io/cpuManagerPolicy: 集群CPU管理策略。取值为none或static,默认为none。

    • none:关闭工作负载实例独占CPU核的功能,优点是CPU共享池的可分配核数较多

    • static:支持给工作负载实例配置CPU独占,适用于对CPU缓存和调度延迟敏感的工作负载。

supportIstio

Boolean

支持Istio

表8 HostNetwork

参数

参数类型

描述

vpc

String

用于创建控制节点的VPC的ID。该值在创建VPC和子网中获取。

获取方法如下:

  • 方法1:登录虚拟私有云服务的控制台界面,在虚拟私有云的详情页面查找VPC ID。

  • 方法2:通过虚拟私有云服务的API接口查询,具体操作可参考查询VPC列表

说明:

当前vpc-router容器网络模型不支持对接含拓展网段的VPC。 若您的用户类型为企业用户,则需要保证vpc所属的企业项目ID和集群创建时选择的企业项目ID一致。集群所属的企业项目ID通过extendParam字段下的enterpriseProjectId体现,该值默认为"0",表示默认的企业项目。

最小长度:0

最大长度:64

subnet

String

用于创建控制节点的subnet的网络ID。获取方法如下:

  • 方法1:登录虚拟私有云服务的控制台界面,单击VPC下的子网,进入子网详情页面,查找网络ID。

  • 方法2:通过虚拟私有云服务的API接口查询,具体操作可参考查询子网列表

最小长度:0

最大长度:64

highwaySubnet

String

用于创建裸金属节点的高速网络的子网ID。该值在创建高速网络(可选)中获取。创建裸金属集群时该参数为必选参数。

最小长度:0

最大长度:64

SecurityGroup

String

节点安全组ID,创建时指定无效

表9 ContainerNetwork

参数

参数类型

描述

mode

String

容器网络类型(只可选择其一)

  • overlay_l2:通过OVS(OpenVSwitch)为容器构建的overlay _ l2网络。

  • underlay_ipvlan:裸金属服务器使用ipvlan构建的Underlay的l2网络。

  • vpc-router:使用ipvlan和自定义VPC路由为容器构建的Underlay的l2网络。

  • eni:Yangtse网络,深度整合VPC原生ENI弹性网卡能力,采用VPC网段分配容器地址,支持ELB直通容器,享有高性能,创建CCE Turbo集群(公测中)时指定。

说明:
  • 容器隧道网络(Overlay):基于VXLAN技术实现的Overlay容器网络。VXLAN是将以太网报文封装成UDP报文进行隧道传输。容器网络是承载于VPC网络之上的Overlay网络平面,具有付出少量隧道封装性能损耗,获得了通用性强、互通性强、高级特性支持全面(例如Network Policy网络隔离)的优势,可以满足大多数应用需求。

  • VPC网络:基于VPC网络的自定义路由,直接将容器网络承载于VPC网络之中。每个节点将会被分配固定大小的IP地址段。vpc-router网络由于没有隧道封装的消耗,容器网络性能相对于容器隧道网络有一定优势。vpc-router集群由于VPC路由中配置有容器网段与节点IP的路由,可以支持集群外直接访问容器实例等特殊场景。

缺省值:"'

最小长度:0

最大长度:64

枚举值:

  • overlay_l2

  • vpc-router

  • underlay_ipvlan

  • eni

cidr

String

容器网络网段,建议使用网段10.0.0.0/12~19,172.16.0.0/16~19,192.168.0.0/16~19,如存在网段冲突,将自动重新选择。

当节点最大实例数为默认值110时,当前容器网段至少支持582个节点,此参数在集群创建后不可更改,请谨慎选择。

最小长度:0

最大长度:64

表10 ENINetwork

参数

参数类型

描述

eniSubnetId

String

eni子网ID

eniSubnetCIDR

String

ENI子网CIDR

表11 Authentication

参数

参数类型

描述

mode

String

集群认证模式。

  • kubernetes 1.11及之前版本的集群支持“x509”、“rbac”和“authenticating_proxy”,默认取值为“x509”。

  • kubernetes 1.13及以上版本的集群支持“rbac”和“authenticating_proxy”,默认取值为“rbac”。

authenticatingProxy

AuthenticatingProxy object

authenticatingProxy模式相关配置。认证模式为authenticating_proxy时必选。

表12 AuthenticatingProxy

参数

参数类型

描述

ca

String

authenticating_proxy模式配置的x509格式CA证书(base64编码)。 最大长度:1M

表13 MasterSpec

参数

参数类型

描述

availabilityZone

String

可用区

flavor

String

规格

表14 ResourceTag

参数

参数类型

描述

key

String

Key值。

  • 支持最大长度未36个UTF-8字符。

  • 不支持特殊字符[=*<>\,|/]+

  • 不支持ASCII控制字符(0-31)

最小长度:1

最大长度:36

value

String

Value值。

  • 支持最大长度未43个UTF-8字符。

  • 不支持特殊字符[=*<>\,|/]+

  • 不支持ASCII控制字符(0-31)

最大长度:43

表15 ClusterStatus

参数

参数类型

描述

phase

String

集群状态,取值如下

  • Available:可用,表示集群处于正常状态。

  • Unavailable:不可用,表示集群异常,需手动删除或联系管理员删除。

  • ScalingUp:扩容中,表示集群正处于扩容过程中。

  • ScalingDown:缩容中,表示集群正处于缩容过程中。

  • Creating:创建中,表示集群正处于创建过程中。

  • Deleting:删除中,表示集群正处于删除过程中。

  • Upgrading:升级中,表示集群正处于升级过程中。

  • Resizing:规格变更中,表示集群正处于变更规格中。

  • Empty:集群无任何资源

jobID

String

作业ID

reason

String

集群变为当前状态的原因,在集群在非“Available”状态下时,会返回此参数。

message

String

集群变为当前状态的原因的详细信息,在集群在非“Available”状态下时,会返回此参数。

endpoints

ClusterEndpoints object

集群中 kube-apiserver 的访问地址。

isLocked

Boolean

CBC资源锁定

lockScene

String

CBC资源锁定场景

lockSource

String

锁定资源

lockSourceId

String

锁定的资源ID

deleteOption

Object

删除配置状态(仅删除请求响应包含)

deleteStatus

Object

删除状态信息(仅删除请求响应包含)

表16 ClusterEndpoints

参数

参数类型

描述

url

String

集群中 kube-apiserver 的访问地址

type

String

集群访问地址的类型

  • Internal:用户子网内访问的地址

  • External:公网访问的地址

请求示例

响应示例

状态码为 200 时:

表示获取集群列表成功。

{
  "kind" : "Cluster",
  "apiVersion" : "v3",
  "items" : [ {
    "kind" : "Cluster",
    "apiVersion" : "v3",
    "metadata" : {
      "name" : "mycluster",
      "uid" : "4d1ecb2c-229a-11e8-9c75-0255ac100ceb",
      "creationTimestamp" : "2018-08-02 03:48:58.968214406 +0000 UTC",
      "updateTimestamp" : "2018-08-02 04:05:29.386391813 +0000 UTC"
    },
    "spec" : {
      "type" : "VirtualMachine",
      "flavor" : "cce.s1.small",
      "version" : "v1.7.3-r13",
      "description" : "awesome cluster",
      "hostNetwork" : {
        "vpc" : "f0c12911-4fdb-4284-9230-7ffb0860826a",
        "subnet" : "ac274229-fd2e-4695-9f01-a0c1372b8006"
      },
      "containerNetwork" : {
        "mode" : "overlay_l2",
        "cidr" : "172.16.0.0/16"
      },
      "authentication" : {
        "mode" : "x509",
        "authenticatingProxy" : { }
      },
      "billingMode" : 0
    },
    "status" : {
      "phase" : "Available",
      "endpoints" : [ {
        "url" : "https://192.168.0.11:5443",
        "type" : "Internal"
      } ]
    }
  } ]
}

状态码

状态码

描述

200

表示获取集群列表成功。

错误码

请参见错误码

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!非常感谢您的反馈,我们会继续努力做到更好!
反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问