获取指定项目下的集群

project_id

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

账号的项目ID

默认取值：

不涉及

detail

否

String

参数解释：

查询集群详细信息。

约束限制：

不涉及

取值范围：

若设置为true，获取集群下节点总数(totalNodesNumber)、正常节点数(activeNodesNumber)、CPU总量(totalNodesCPU)、内存总量(totalNodesMemory)、已安装插件列表(installedAddonInstances)，已安装插件列表中包含名称(addonTemplateName)、版本号(version)、插件的状态信息(status)、是否支持节点池伸缩组(supportNodePoolScaleGroup)，放入到annotation中。

默认取值：

无

status

否

String

参数解释：

集群状态。

约束限制：

不涉及

取值范围：

• Available：可用，表示集群处于正常状态。

• Unavailable：不可用，表示集群异常，需手动删除。

• ScalingUp：扩容中，表示集群正处于扩容过程中。

• ScalingDown：缩容中，表示集群正处于缩容过程中。

• Creating：创建中，表示集群正处于创建过程中。

• Deleting：删除中，表示集群正处于删除过程中。

• Upgrading：升级中，表示集群正处于升级过程中。

• Resizing：规格变更中，表示集群正处于变更规格中。

• ResizeFailed：规格变更异常，表示集群变更规格异常。

• RollingBack：回滚中，表示集群正处于回滚过程中。

• RollbackFailed：回滚异常，表示集群回滚异常。

• Hibernating：休眠中，表示集群正处于休眠过程中。

• Hibernation：已休眠，表示集群正处于休眠状态。

• Freezing：冻结中，表示集群正处于冻结过程中。

• Frozen：已冻结，表示集群正处于冻结状态。

• UnFreezing：解冻中，表示集群正处于解冻过程中。

• Awaking：唤醒中，表示集群正处于从休眠状态唤醒的过程中。

• Empty：集群无任何资源（已废弃）

• Error：错误，表示集群资源异常，可尝试手动删除。

默认取值：

不涉及

type

否

String

参数解释：

集群类型。

约束限制：

不涉及：

取值范围：

• VirtualMachine：CCE集群

• ARM64：鲲鹏集群

默认取值：

不涉及

version

否

String

参数解释：

集群版本过滤。

约束限制：

不涉及

取值范围：

集群版本

默认取值：

无

Content-Type

是

String

参数解释：

消息体的类型（格式）

约束限制：

GET方法不做校验

取值范围：

• application/json

• application/json;charset=utf-8

• application/x-pem-file

• multipart/form-data（注：存在FormData参数时使用）

默认取值：

不涉及

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

kind

String

参数解释：

API类型。

约束限制：

该值不可修改。

取值范围：

不涉及

默认取值：

Cluster

apiVersion

String

参数解释：

API版本。

约束限制：

该值不可修改。

取值范围：

不涉及

默认取值：

v3

items

Array of Cluster objects

参数解释：

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

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

kind

String

参数解释：

API类型。

约束限制：

该值不可修改

取值范围：

• Cluster

• cluster

默认取值：

不涉及

apiVersion

String

参数解释：

API版本。

约束限制：

该值不可修改

取值范围：

• v3

默认取值：

不涉及

metadata

ClusterMetadata object

参数解释：

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

约束限制：

不涉及

spec

ClusterSpec object

参数解释：

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

约束限制：

不涉及

status

ClusterStatus object

参数解释：

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

约束限制：

不涉及

name

String

参数解释：

集群名称。

约束限制：

不涉及

取值范围：

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

默认取值：

不涉及

uid

String

参数解释：

集群ID，资源唯一标识。

约束限制：

创建成功后自动生成，填写无效。在创建包周期集群时，响应体不返回集群ID。

取值范围：

不涉及

默认取值：

不涉及

alias

String

参数解释：

集群显示名，用于在 CCE 界面显示，该名称创建后可修改。显示名和其他集群的名称、显示名不可以重复。

约束限制：

在创建集群、更新集群请求体中，集群显示名alias未指定或取值为空，表示与集群名称name一致。在创建集群等响应体中，集群显示名alias未配置时将不返回。

取值范围：

以中文或英文字符开头，由数字、中文、英文字符、中划线（-）组成，长度范围 4-128位，且不能以中划线（-）开头和结尾。

默认取值：

不涉及

annotations

Map<String,String>

参数解释：

集群注解，由key/value组成：

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

约束限制：

该字段不会被数据库保存，当前仅用于指定集群待安装插件。

取值范围：

不涉及

默认取值：

不涉及

说明：

• Annotations不用于标识和选择对象。Annotations中的元数据可以是small或large，structured或unstructured，并且可以包括标签不允许使用的字符。

• 可通过加入"cluster.install.addons.external/install":"[{"addonTemplateName":"icagent"}]"的键值对在创建集群时安装ICAgent。

labels

Map<String,String>

参数解释：

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

约束限制：

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

取值范围：

不涉及

默认取值：

不涉及

creationTimestamp

String

参数解释：

集群创建时间。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

updateTimestamp

String

参数解释：

集群更新时间。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

timezone

String

参数解释：

集群时区。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

category

String

参数解释：

集群类别。

约束限制：

不涉及

取值范围：

• CCE：CCE集群

  CCE集群支持虚拟机与裸金属服务器混合、GPU、NPU等异构节点的混合部署，基于高性能网络模型提供全方位、多场景、安全稳定的容器运行环境。

• Turbo: CCE Turbo集群。

  全面基于云原生基础设施构建的云原生2.0的容器引擎服务，具备软硬协同、网络无损、安全可靠、调度智能的优势，为用户提供一站式、高性价比的全新容器服务体验。

默认取值：

容器网络参数设置非eni模式时，默认为CCE

容器网络参数设置为eni模式时，默认为Turbo

type

String

参数解释：

集群Master节点架构

约束限制：

不涉及

取值范围：

• VirtualMachine：Master节点为x86架构服务器

• ARM64: Master节点为鲲鹏（ARM架构）服务器

默认取值：

VirtualMachine

flavor

String

参数解释：

集群规格，当集群为v1.15及以上版本时支持创建后变更，详情请参见变更集群规格。请按实际业务需求进行选择

约束限制：

不涉及

取值范围：

• cce.s1.small: 小规模单控制节点CCE集群（最大50节点）

• cce.s1.medium: 中等规模单控制节点CCE集群（最大200节点）

• cce.s2.small: 小规模三控制节点CCE集群（最大50节点）

• cce.s2.medium: 中等规模三控制节点CCE集群（最大200节点）

• cce.s2.large: 大规模三控制节点CCE集群（最大1000节点）

• cce.s2.xlarge: 超大规模三控制节点CCE集群（最大2000节点）

默认取值：

不涉及

说明：

关于规格参数中的字段说明如下：

• s1：单控制节点的集群，控制节点数为1。单控制节点故障后，集群将不可用，但已运行工作负载不受影响。

• s2：三控制节点的集群，即高可用集群，控制节点数为3。当某个控制节点故障时，集群仍然可用。

• dec：表示专属云的CCE集群规格。例如cce.dec.s1.small表示小规模单控制节点的专属云CCE集群（最大50节点）。

• small：表示集群支持管理的最大节点规模为50节点。

• medium：表示集群支持管理的最大节点规模为200节点。

• large：表示集群支持管理的最大节点规模为1000节点。

• xlarge：表示集群支持管理的最大节点规模为2000节点。

version

String

参数解释：

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

在CCE控制台支持创建三种最新版本的集群。可登录CCE控制台创建集群，在“版本”处获取到集群版本。

其它集群版本，当前仍可通过api创建，但后续会逐渐下线，具体下线策略请关注CCE官方公告。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

• 若不配置，默认创建最新版本的集群。

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

说明：

• Turbo集群支持1.19及以上版本商用。

platformVersion

String

参数解释：

CCE集群平台版本号，表示集群版本(version)下的内部版本。用于跟踪某一集群版本内的迭代，集群版本内唯一，跨集群版本重新计数。

约束限制：

不支持用户指定，集群创建时自动选择对应集群版本的最新平台版本。

取值范围：

platformVersion格式为：cce.X.Y

• X: 表示内部特性版本。集群版本中特性或者补丁修复，或者OS支持等变更场景。其值从1开始单调递增。

• Y: 表示内部特性版本的补丁版本。仅用于特性版本上线后的软件包更新，不涉及其他修改。其值从0开始单调递增。

默认取值：

不涉及

legacyVersion

String

参数解释：

CCE集群旧版本（已废弃），无实际功能，仅用于集群version与platformVersion组合展示，该版本号全局内唯一。如集群version为va.b, platformVersion为cce.X.Y，则legacyVersion值为va.b.X-rY。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

description

String

参数解释：

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

约束限制：

仅支持utf-8编码。

取值范围：

不涉及

默认取值：

不涉及

customSan

Array of strings

参数解释：

集群的API Server服务端证书中的自定义SAN（Subject Alternative Name）字段，遵从SSL标准X509定义的格式规范。

约束限制：

不允许出现同名重复。

取值范围：

格式符合IP和域名格式。

默认取值：

不涉及

示例:

SAN 1: DNS Name=example.com
SAN 2: DNS Name=www.example.com
SAN 3: DNS Name=example.net
SAN 4: IP Address=93.184.216.34

ipv6enable

Boolean

参数解释：

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

约束限制：

开启IPv6后不支持iptables转发模式；VPC网络模式不支持IPv4/IPv6双栈网络。

取值范围：

• true: 开启IPv4/IPv6双栈模式

• false: 仅使用IPv4模式

默认取值：

false

hostNetwork

HostNetwork object

参数解释：

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

约束限制：

不涉及

containerNetwork

ContainerNetwork object

参数解释：

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

约束限制：

不涉及

eniNetwork

EniNetwork object

参数解释：

云原生网络2.0网络配置，创建CCE Turbo集群时指定。

约束限制：

不涉及

serviceNetwork

ServiceNetwork object

参数解释：

服务网段参数，包含IPv4 CIDR。

约束限制：

不涉及

publicAccess

PublicAccess object

参数解释：

集群API访问控制。

约束限制：

不涉及

authentication

Authentication object

参数解释：

集群认证方式相关配置。

约束限制：

不涉及

billingMode

Integer

参数解释：

集群的计费方式。

约束限制：

不涉及

取值范围：

• 0: 按需计费

• 1: 包周期

默认取值：

默认0。

masters

Array of MasterSpec objects

参数解释：

控制节点的高级配置。

约束限制：

该参数未配置时将不返回。

kubernetesSvcIpRange

String

参数解释：

服务网段参数，kubernetes clusterIP取值范围，1.11.7版本及以上支持。创建集群时如若未传参，默认为"10.247.0.0/16"。该参数废弃中，推荐使用新字段serviceNetwork，包含IPv4服务网段。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

clusterTags

Array of ResourceTag objects

参数解释：

集群资源标签。

约束限制：

不涉及

kubeProxyMode

String

参数解释：

服务转发模式。

约束限制：

不涉及

取值范围：

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

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

默认取值：

默认使用iptables转发模式。

az

String

参数解释：

可用区（仅查询返回字段）。

CCE支持的可用区请参考地区和终端节点。

约束限制：

不涉及

extendParam

ClusterExtendParam object

参数解释：

集群扩展字段，可配置多可用区集群、专属CCE集群，以及将集群创建在特定的企业项目下等。

约束限制：

不涉及

supportIstio

Boolean

参数解释：

支持Istio。

约束限制：

不涉及

取值范围：

• true: 支持istio

• false: 不支持istio

默认取值：

默认true

enableDistMgt

Boolean

参数解释：

集群开启对分布式云支持。

约束限制：

目前只有Turbo集群支持。

取值范围：

• true: 开启对分布式云支持

• false: 关闭对分布式云支持

默认取值：

默认false

deletionProtection

Boolean

参数解释：

集群删除保护，如果开启后用户将无法删除该集群。

约束限制：

不涉及。

取值范围：

• true: 开启集群删除保护

• false: 关闭集群删除保护

默认取值：

默认false

configurationsOverride

Array of PackageConfiguration objects

参数解释：

覆盖集群默认组件配置。

当前支持的可配置组件及其参数详见配置管理。

约束限制：

若指定了不支持的组件或组件不支持的参数，该配置项将被忽略。

clusterOps

ClusterOps object

参数解释：

集群运维相关配置。

约束限制：

不涉及

enableAutopilot

Boolean

参数解释：

是否为Autopilot集群。

约束限制：

不涉及

取值范围：

• true: 创建Autopilot类型集群

• false: 创建CCE/Turbo类型集群

默认取值：

默认false

encryptionConfig

EncryptionConfig object

参数解释：

secret资源落盘加密配置，当前仅支持配置一种加密方式。默认使用cce托管密钥（用户侧不感知该密钥）进行加密。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

vpc

String

参数解释：

用于创建控制节点的VPC的ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

获取方法如下：

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

• 方法2：通过虚拟私有云服务的API接口查询。

  链接请参见查询VPC列表。

subnet

String

参数解释：

用于创建控制节点的subnet的网络ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

不涉及

获取方法如下：

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

• 方法2：通过虚拟私有云服务的查询子网列表接口查询。

  链接请参见查询子网列表。

SecurityGroup

String

参数解释：

集群默认的Node节点安全组ID。

约束限制：

不涉及

取值范围：

不涉及

默认取值：

• 不指定该字段系统将自动为用户创建默认Node节点安全组。

• 指定该字段时集群将绑定指定的安全组。

说明：

指定Node节点安全组需要放通部分端口来保证正常通信。详细设置请参考集群安全组规则配置。

controlPlaneSecurityGroup

String

参数解释：

集群控制面节点安全组ID。

约束限制：

创建成功后自动生成，填写无效。

取值范围：

不涉及

默认取值：

不涉及

mode

String

参数解释：

容器网络类型。

约束限制：

只可选择一个容器网络类型。

取值范围：

• overlay_l2：容器隧道网络，通过OVS（OpenVSwitch）为容器构建的overlay_l2网络。

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

• eni：云原生网络2.0，深度整合VPC原生ENI弹性网卡能力，采用VPC网段分配容器地址，支持ELB直通容器，享有高性能，创建CCE Turbo集群时指定。

默认取值：

不涉及

cidr

String

参数解释：

容器网络网段，建议使用网段10.0.0.0/12~19，172.16.0.0/16~19，192.168.0.0/16~19，如存在网段冲突，将会报错。

约束限制：

此参数在集群创建后不可更改，请谨慎选择。（已废弃，如填写cidrs将忽略该cidr）

vpc网络模式的集群在创建后可以新增网段参数，不可修改已有网段参数，需要重新创建集群才能调整。

取值范围：

满足IPv4 CIDR格式

默认取值：

不填此参数时，将从172.(16 ~ 31).0.0/16、10.(0 | 16 | 32 | 48 | 64 | 80 | 96 | 112).0.0/12中随机分配一个不冲突的网段供用户使用。

cidrs

Array of ContainerCIDR objects

参数解释：

容器网络网段列表。1.21及新版本集群使用cidrs字段，当集群网络类型为vpc-router类型时，支持多个容器网段，最多配置20个；1.21之前版本若使用cidrs字段，则取值cidrs数组中的第一个cidr元素作为容器网络网段地址。

约束限制：

容器隧道网络模式的集群在创建之后，无法修改网段参数；

vpc网络模式的集群在创建后可以新增网段参数，不可修改已有网段参数，需要重新创建集群才能调整。

cidr

String

参数解释：

容器网络网段，建议使用网段10.0.0.0/12~19，172.16.0.0/16~19，192.168.0.0/16~19。

约束限制：

如存在网段冲突，将会报错。

取值范围：

不涉及

默认取值：

不涉及

eniSubnetId

String

参数解释：

ENI所在子网的IPv4子网ID。

约束限制：

暂不支持IPv6,废弃中，推荐使用新字段subnets。

取值范围：

不涉及

默认取值：

不涉及

获取方法如下：

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

• 方法2：通过虚拟私有云服务的查询子网列表接口查询。

  链接请参见查询子网列表。