更新指定的集群

project_id

是

String

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

cluster_id

是

String

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

Content-Type

是

String

消息体的类型（格式）

X-Auth-Token

是

String

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

spec

是

AutopilotClusterInformationSpec object

具体集群参数

metadata

否

AutopilotClusterMetadataForUpdate object

集群基本信息，包含与名称相关的字段

description

否

String

集群的描述信息。

1. 字符取值范围[0,200]。不包含~$%^&*<>[]{}()'"#\等特殊字符。

2. 仅运行（Available）的集群允许修改。

customSan

否

Array of strings

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

1. 不允许出现同名重复。

2. 格式符合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

eniNetwork

否

AutopilotEniNetworkUpdate object

云原生网络2.0网络配置，包含集群的容器子网信息。

subnets

否

Array of AutopilotNetworkSubnet objects

IPv4子网ID列表。

只允许新增子网，不可删除已有子网，请谨慎选择。

请求体中需包含所有已经存在的subnet。

subnetID

是

String

用于创建控制节点的subnet的IPv4子网ID(暂不支持IPv6)。获取方法如下：

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

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

  链接请参见查询子网列表

alias

否

String

集群显示名。

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

显示名和其他集群的名称、显示名不可以重复。

为空时表示不进行修改。

kind

String

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

apiVersion

String

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

metadata

AutopilotClusterMetadata object

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

spec

AutopilotClusterSpec object

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

status

AutopilotClusterStatus object

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

name

String

集群名称。

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

uid

String

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

alias

String

集群显示名，用于在 CCE 界面显示，该名称创建后可修改。

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

显示名和其他集群的名称、显示名不可以重复。

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

annotations

Map<String,String>

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

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

labels

Map<String,String>

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

creationTimestamp

String

集群创建时间

updateTimestamp

String

集群更新时间

category

String

集群类别。

type

String

集群Master节点架构：

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

flavor

String

集群规格，cce.autopilot.cluster

version

String

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

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

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

platformVersion

String

CCE集群平台版本号，表示集群版本(version)下的内部版本。用于跟踪某一集群版本内的迭代，集群版本内唯一，跨集群版本重新计数。不支持用户指定，集群创建时自动选择对应集群版本的最新平台版本。

platformVersion格式为：cce.X.Y

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

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

description

String

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

customSan

Array of strings

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

1. 不允许出现同名重复。

2. 格式符合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

enableSnat

Boolean

集群是否配置镜像访问。为确保您的集群节点可以从容器镜像服务中拉取镜像，默认使用所选VPC中已有的SWR和OBS终端节点，否则将会为您自动新建SWR和OBS终端节点。

enableSWRImageAccess

Boolean

集群是否配置SNAT。开启后您的集群可以通过NAT网关访问公网，默认使用所选的VPC中已有的NAT网关，否则系统将会为您自动创建一个默认规格的NAT网关并绑定弹性公网IP，自动配置SNAT规则。

enableAutopilot

Boolean

是否为Autopilot集群。

ipv6enable

Boolean

集群是否使用IPv6模式。

hostNetwork

AutopilotHostNetwork object

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

containerNetwork

AutopilotContainerNetwork object

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

eniNetwork

AutopilotEniNetwork object

云原生网络2.0网络配置。

serviceNetwork

AutopilotServiceNetwork object

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

authentication

AutopilotAuthentication object

集群认证方式相关配置。

billingMode

Integer

集群的计费方式。

• 0: 按需计费

默认为“按需计费”。

kubernetesSvcIpRange

String

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

clusterTags

Array of AutopilotResourceTag objects

集群资源标签

kubeProxyMode

String

服务转发模式：

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

az

String

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

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

extendParam

AutopilotClusterExtendParam object

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

supportIstio

Boolean

支持Istio

configurationsOverride

Array of AutopilotPackageConfiguration objects

覆盖集群默认组件配置

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

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

配置管理

vpc

String

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

获取方法如下：

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

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

  链接请参见查询VPC列表

subnet

String

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

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

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

  链接请参见查询子网列表

mode

String

容器网络类型

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

subnets

Array of AutopilotNetworkSubnet objects

ENI所在子网的IPv4子网ID列表。获取方法如下：

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

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

  链接请参见查询子网列表

subnetID

String

用于创建控制节点的subnet的IPv4子网ID(暂不支持IPv6)。获取方法如下：

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

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

  链接请参见查询子网列表

IPv4CIDR

String

kubernetes clusterIP IPv4 CIDR取值范围。创建集群时若未传参，默认为"10.247.0.0/16"。

mode

String

集群认证模式。默认取值为“rbac”。

key

String

Key值。

• 不能为空，最多支持128个字符

• 可用UTF-8格式表示的汉字、字母、数字和空格

• 支持部分特殊字符：_.:/=+-@

• 不能以"_sys_"开头

value

String

Value值。

• 可以为空但不能缺省，最多支持255个字符

• 可用UTF-8格式表示的汉字、字母、数字和空格

• 支持部分特殊字符：_.:/=+-@

enterpriseProjectId

String

集群所属的企业项目ID。

upgradefrom

String

记录集群通过何种升级方式升级到当前版本。

name

String

组件名称

configurations

Array of AutopilotConfigurationItem objects

组件配置项

name

String

组件配置项名称

value

Object

组件配置项值

phase

String

集群状态，取值如下

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

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

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

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

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

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

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

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

jobID

String

任务ID,集群当前状态关联的任务ID。当前支持:

• 创建集群时返回关联的任务ID，可通过任务ID查询创建集群的附属任务信息；

• 删除集群或者删除集群失败时返回关联的任务ID，此字段非空时，可通过任务ID查询删除集群的附属任务信息。

reason

String

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

message

String

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

endpoints

Array of AutopilotClusterEndpoints objects

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

isLocked

Boolean

CBC资源锁定

lockScene

String

CBC资源锁定场景

lockSource

String

锁定资源

lockSourceId

String

锁定的资源ID

deleteOption

Object

删除配置状态（仅删除请求响应包含）

deleteStatus

Object

删除状态信息（仅删除请求响应包含）

url

String

集群中 kube-apiserver 的访问地址

type

String

集群访问地址的类型

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

• External：公网访问的地址

200

表示更新指定集群成功。