文档

CreateCluster - 创建集群

更新时间:

您可以通过OpenAPI创建ACK集群,包含ACK托管集群、ACK专有集群、ACK Serverless集群,ACK Edge集群以及注册集群。创建集群时,您将完成集群信息、集群组件以及ACK相关云资源的配置。

接口说明

调试

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

授权信息

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

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

请求语法

POST /clusters

请求参数

名称类型必填描述示例值
bodyobject

请求体参数。

namestring

集群名称。

命名规则:由数字、汉字、英文字符或短划线(-)组成,长度范围 1~63 个字符,且不能以短划线(-)开头。

cluster-demo
region_idstring

集群所在的地域 ID。

cn-beijing
cluster_typestring
  • Kubernetes: ACK 专有集群。
  • ManagedKubernetes:ACK 托管类的集群,包括 ACK 托管集群(ACK 集群 Pro 版、ACK 集群基础版)、ACK Serverless 集群(Pro 版、基础版)、ACK Edge 集群(Pro 版、基础版)、ACK 灵骏集群(Pro 版)。
  • ExternalKubernetes:注册集群。
Kubernetes
cluster_specstring

当您选择cluster_typeManagedKubernetes并配置profile后,您可以进一步指定集群的规格。

  • ack.pro.small:集群 Pro 版。
  • ack.standard:集群基础版(取值为空时默认选择)。
ack.pro.small
kubernetes_versionstring

集群版本,与 Kubernetes 社区基线版本保持一致。建议选择最新版本,若不指定,默认使用最新版本。

目前您可以在 ACK 控制台创建两种最新版本的集群。您可以通过 API 创建其他 Kubernetes 版本集群。关于 ACK 支持的 Kubernetes 版本,请参见 Kubernetes 版本发布概览

1.16.9-aliyun.1
runtimeruntime

集群内容器运行时,默认采用 Docker 运行时,同时还支持 Containerd 和安全沙箱容器运行时。

更多有关容器引擎的选择,请参见如何选择 Docker 运行时与安全沙箱运行时

vpcidstring

集群使用的专有网络,创建集群时必须为集群提供。

vpc-2zeik9h3ahvv2zz95****
pod_vswitch_idsarray

Pod 虚拟交换机列表,您需要为每一个节点虚拟交换机指定至少一个相同可用区的 Pod 虚拟交换机并且不能跟节点vswitch重复,建议选择网段掩码不大于 19 的虚拟交换机。

说明 当集群采用 Terway 网络类型时,必须为集群指定pod_vswitch_ids
string

Pod 虚拟交换机列表,您需要为每一个节点虚拟交换机指定至少一个相同可用区的 Pod 虚拟交换机并且不能跟节点vswitch重复,建议选择网段掩码不大于 19 的虚拟交换机。

说明 当集群采用 Terway 网络类型时,必须为集群指定pod_vswitch_ids
vsw-2ze97jwri7cei0mpw****
container_cidrstring

Pod 网络地址段,必须是有效的私有网段,即以下网段及其子网:10.0.0.0/8、172.16-31.0.0/12-16、192.168.0.0/16。不能与 VPC 及 VPC 内已有 Kubernetes 集群使用的网段重复,创建成功后不能修改。

有关集群网络规划,请参见VPC 下 Kubernetes 的网络地址段规划

说明 当创建 Flannel 网络类型的集群时,该字段为必填。
172.20.0.0/16
service_cidrstring

Service 网络地址段,可选范围:10.0.0.0/16-24,172.16-31.0.0/16-24,192.168.0.0/16-24 不能与 VPC 网段 10.1.0.0/21 及 VPC 内已有 Kubernetes 集群使用的网段重复,创建成功后不能修改。

默认使用 172.19.0.0/20 网段。

172.21.0.0/20
security_group_idstring

使用已有安全组创建集群时需要指定安全组 ID,和is_enterprise_security_group二选一,集群节点自动加入到此安全组。

sg-bp1bdue0qc1g7k****
is_enterprise_security_groupboolean

自动创建企业级安全组,当security_group_id为空的时生效。

说明 使用普通安全组时,集群内节点与 Terway Pod 数量之和不能超过 2000。所以创建 Terway 网络类型集群时,建议使用企业安全组。
  • true:创建并使用企业级安全组。
  • false:不使用企业级安全组。

默认值:true

true
snat_entryboolean

为专有网络配置 SNAT。取值:

  • true:将为您创建 NAT 网关并自动配置 SNAT 规则,若您集群内的节点、应用等需要访问公网需要设置为true
  • false:不为您创建 NAT 网关及 SNAT 规则。这种模式下,集群内节点及应用将不能访问公网。
说明 如果创建集群时未开启,后续业务需要访问公网,可手动开启。更多信息,请参见手动开启

默认值:true

true
endpoint_public_accessboolean

是否开启公网访问。通过 EIP 暴露 API Server,实现集群公网访问。

  • true:开启公网访问。
  • false:不开启公网访问。选择不开放时,则无法通过外网访问集群 API Server。

默认值:false

true
ssh_flagsboolean

是否开放公网 SSH 登录。用登录"专有版集群"的 Master 节点,托管版集群中该参数不生效。

  • true:表示开放。
  • false:表示不开放。

默认值:false

true
timezonestring

集群使用的时区。

Asia/Shanghai
node_cidr_maskstring

节点 IP 数量,通过指定网络的 CIDR 来确定 IP 的数量,只对于 Flannel 网络类型集群生效。

默认值:26

25
user_castring

自定义集群 CA。

-----BEGIN CERTIFICATE-----****
user_datastring

自定义节点数据。

IyEvdXNyL2Jpbi9iYXNoCmVjaG8gIkhlbGxvIEFD****
cluster_domainstring

集群本地域名。

命名规则:域名由小数点(.)分隔的一个或多个部分构成,每个部分最长为 63 个字符,可以使用小写字母、数字和短划线(-),且首尾必须为小写字母或数字。

cluster.local
node_name_modestring

自定义节点名称。

节点名称由三部分组成:前缀+节点 IP 地址子串+后缀:

  • 前缀和后缀均可由英文句号(.)分隔的一个或多个部分构成,每个部分可以使用小写字母、数字和短划线(-),且首尾必须为小写字母和数字。
  • IP 地址段长度指截取节点 IP 地址末尾的位数,取值范围[5,12]。

例如,节点 IP 地址为:192.168.0.55,指定前缀为 aliyun.com,IP 地址段长度为 5,后缀为 test,则节点名称为 aliyun.com00055test。

aliyun.com00055test
custom_sanstring

自定义证书 SAN,多个 IP 或域名以英文逗号(,)分隔。

cs.aliyun.com
encryption_provider_keystring

KMS 密钥 ID,使用该密钥对数据盘进行加密。更多详情,请参见密钥管理服务

说明 该功能只在专业托管版集群(ACK Pro 版集群)中生效。
0fe64791-55eb-4fc7-84c5-c6c7cdca****
service_account_issuerstring

ServiceAccount 是 Pod 和集群apiserver通讯的访问凭证。而service-account-issuerserviceaccount token中的签发身份,即token payload中的iss字段。

关于ServiceAccount更多详情,请参见部署服务账户令牌卷投影

kubernetes.default.svc
api_audiencesstring

ServiceAccount 是 Pod 和集群apiserver通讯的访问凭证,而api-audiences是合法的请求token身份,用于apiserver服务端认证请求token是否合法。支持配置多个audience,通过英文逗号(,)分割。

关于ServiceAccount更多详情,请参见部署服务账户令牌卷投影

kubernetes.default.svc
image_idstring

节点自定义镜像,默认使用系统镜像。当选择自定义镜像时,将取代默认系统镜像。请参见自定义镜像

m-bp16z7xko3vvv8gt****
rds_instancesarray

RDS 实例列表,选择您想想要添加白名单的 RDS 实例。 建议前往 RDS 加入容器 Pod 网段与 Node 网段,设置 RDS 实例会由于实例非运行的状态导致无法弹出。

string

RDS 实例列表,选择您想想要添加白名单的 RDS 实例。 建议前往 RDS 加入容器 Pod 网段与 Node 网段,设置 RDS 实例会由于实例非运行的状态导致无法弹出。

rm-2zev748xi27xc****
tagsarray

节点标签。标签定义规则:

  • 标签由区分大小写的键值对组成,您最多可以设置 20 个标签。
  • 标签键不可以重复,最长为 64 个字符;标签值可以为空,最长为 128 个字符。标签键和标签值都不能以“aliyun”、“acs:”、“https://”或“http://”开头。详情请参见Labels and Selectors
tag

节点标签。标签定义规则:

  • 标签由区分大小写的键值对组成,您最多可以设置 20 个标签。
  • 标签键不可以重复,最长为 64 个字符;标签值可以为空,最长为 128 个字符。标签键和标签值都不能以“aliyun”、“acs:”、“https://”或“http://”开头。详情请参见Labels and Selectors
addonsarray

集群组件列表,创建集群时通过addons指定想要安装的集群组件。

网络组件:必选,包含 Flannel 和 Terway 两种网络类型,创建集群时二选一:

  • Flannel 网络:[{"name":"flannel","config":""}]。
  • Terway 网络:[{"name": "terway-eniip","config": ""}] 。

存储组件:必选,支持csiflexvolume两种类型:

  • csi:[{"name":"csi-plugin","config": ""},{"name": "csi-provisioner","config": ""}]。
  • flexvolume:[{"name": "flexvolume","config": ""}] 。

日志组件:可选。推荐开启,如果不开启日志服务时,将无法使用集群审计功能。

  • 使用已有SLS Project:[{"name": "logtail-ds","config": "{"IngressDashboardEnabled":"true","sls_project_name":"your_sls_project_name"}"}] 。
  • 创建新的SLS Project:[{"name": "logtail-ds","config": "{"IngressDashboardEnabled":"true"}"}] 。

Ingress 组件:可选,ACK 专有版集群默认安装 Ingress 组件nginx-ingress-controller

  • 安装 Ingress 并且开启公网:[{"name":"nginx-ingress-controller","config":"{"IngressSlbNetworkType":"internet"}"}] 。
  • 禁止默认安装 Ingress:[{"name": "nginx-ingress-controller","config": "","disabled": true}] 。

事件中心:可选,默认开启。

事件中心提供对 Kubernetes 事件的存储、查询、告警等能力。Kubernetes 事件中心关联的 Logstore 在 90 天内免费。关于免费策略的更多信息,请参见创建并使用 Kubernetes 事件中心

开启事件中心示例:[{"name":"ack-node-problem-detector","config":"{"sls_project_name":"your_sls_project_name"}"}]。

addon

集群组件列表,创建集群时通过addons指定想要安装的集群组件。

taintsarray

节点污点信息。污点和容忍度(Toleration)相互配合,可以用来避免 Pod 被分配到不合适的节点上。更多信息,请参见taint-and-toleration

taint

节点污点信息。污点和容忍度(Toleration)相互配合,可以用来避免 Pod 被分配到不合适的节点上。更多信息,请参见taint-and-toleration

cloud_monitor_flagsboolean

集群是否安装云监控插件。取值:

  • true:安装云监控插件。
  • false:不安装云监控插件。

默认值:false

true
platformstring

操作系统发行版。取值:

  • CentOS
  • AliyunLinux
  • QbootAliyunLinux
  • Qboot
  • Windows
  • WindowsCore

默认值:CentOS

CentOS
os_typestring

操作系统平台类型。取值:

  • Windows
  • Linux

默认值:Linux

Linux
soc_enabledboolean

等保加固。更多信息,请参见 ACK 等保加固使用说明

取值:

  • true:开启等保加固。
  • false:不开启等保加固。

默认值:false

false
cis_enabledboolean

CIS 安全加固。更多信息,请参见ACK CIS 加固使用说明

取值:

  • true:开启 CIS 安全加固。
  • false:不开启 CIS 安全加固。

默认值:false

false
cpu_policystring

节点 CPU 管理策略。当集群版本在 1.12.6 及以上时支持以下两种策略:

  • static:允许为节点上具有某些资源特征 Pod 增强其 CPU 亲和性和独占性。
  • none:表示启用现有的默认 CPU 亲和性方案。

默认值:none

none
proxy_modestring

kube-proxy 代理模式

  • iptables: 成熟稳定的 kube-proxy 代理模式,Kubernetes Service 的服务发现和负载均衡使用 iptables 规则配置,但是性能一般,受规模影响较大,适用于集群存在少量的 Service。
  • ipvs:高性能的 kube-proxy 代理模式,Kubernetes Service 的服务发现和负载均衡使用 Linux IPVS 模块进行配置,适用于集群存在大量的 Service,对负载均衡有高性能要求的场景。

默认值:ipvs

ipvs
node_port_rangestring

节点服务端口,可选端口范围:[30000,65535]。

默认值:30000-32767

30000~32767
key_pairstring

密钥对名称,和login_password二选一。

secrity-key
login_passwordstring

SSH 登录密码,和key_pair 二选一。密码规则为 8~30 个字符,且至少同时包含三项(大小写字母、数字和特殊符号)。

Hello@1234
master_countlong

Master 节点数量,可选值35

默认值:3

3
master_vswitch_idsarray

Master 节点交换机 ID 列表,交换机个数取值范围为[1,3]。为确保集群的高可用性,推荐您选择 3 个交换机,且分布在不同的可用区。

指定的实例规格数量需要和master_count保持一致,和master_vswitch_ids中的元素一一对应。

string

Master 节点交换机 ID 列表,交换机个数取值范围为[1,3]。为确保集群的高可用性,推荐您选择 3 个交换机,且分布在不同的可用区。

指定的实例规格数量需要和master_count保持一致,和master_vswitch_ids中的元素一一对应。

vsw-2ze3ds0mdip0hdz8i****
master_instance_typesarray

Master 节点实例类型。更多信息,请参见实例规格族

string

Master 节点实例类型。指定的实例规格数量需要和master_count保持一致,和master_instance_types中的元素一一对应。更多信息,请参见实例规格族

ecs.n4.xlarge
master_system_disk_categorystring

Master 节点系统盘类型,取值:

  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD 云盘。
  • cloud_essd:ESSD 云盘。

默认值:cloud_ssd。不同可用区,默认值可能会有所差异。

cloud_ssd
master_system_disk_sizelong

Master 节点系统盘类型,取值范围[40,500],单位:GiB。

默认值:120

120
master_system_disk_performance_levelstring

集群 Master 节点系统盘磁盘性能等级, 仅对 ESSD 磁盘生效。磁盘性能等级和磁盘大小有关,更多信息,请参见 ESSD 云盘

PL1
master_system_disk_snapshot_policy_idstring

Master 节点系统盘采用的自动快照策略 ID。

sp-2zej1nogjvovnz4z****
master_instance_charge_typestring

Master 节点付费类型,取值:

  • PrePaid:包年包月。
  • PostPaid:按量付费。

默认值:PostPaid

PrePaid
master_period_unitstring

Master 节点付费周期,当付费类型为PrePaid的时候必须指定周期。

取值:Month,当前仅支持以月为周期。

Month
master_periodlong

Master 节点包年包月时长,当master_instance_charge_type取值为PrePaid时才生效且为必选值。

取值范围:{1, 2, 3, 6, 12, 24, 36, 48, 60}。

默认值:1。

1
master_auto_renewboolean

Master 节点是否开启自动续费,当master_instance_charge_type取值为PrePaid时才生效,可选值为:

  • true:自动续费。
  • false:不自动续费。

默认值:true

true
master_auto_renew_periodlong

Master 节点自动续费周期,当选择包年包月付费类型时才生效,且为必选值。

取值范围:{1, 2, 3, 6, 12}。

默认值:1。

1
num_of_nodeslong

Worker 节点数。范围是[0,100]。

3
vswitch_idsarray

集群节点所在虚拟交换机,当创建零节点的托管版集群时,该字段必填。

string

集群节点所在虚拟交换机,当创建零节点的托管版集群时,该字段必填。

vsw-2ze3ds0mdip0hdz8i****
worker_vswitch_idsarray

集群节点使用的虚拟交换机列表,一个节点对应一个值。

当创建零节点的托管版集群时,字段worker_vswitch_ids 非必填,但是需要提供vswitch_ids

string

Worker 节点虚拟交换机列表,取值范围:[1,20]。为保证高可用性,建议选择不同可用区的虚拟交换机。

当创建零节点的托管版集群时,字段worker_vswitch_ids 非必填,但是需要提供vswitch_ids

vsw-2ze3ds0mdip0hdz8i****
worker_instance_typesarray

Worker 节点实例配置。

string

Worker 节点实例规格,至少要指定一个实例规格。更多信息,请参见实例规格族

说明 实例规格优先级随着在数据中的位置增大依次降低。当无法根据优先级较高的实例规格创建出实例时,会自动选择下一优先级的实例规格来创建实例。
ecs.n4.large
worker_system_disk_categorystring

Worker 节点系统盘类型。更多信息,请参见块存储概述

取值:

  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD 云盘。

默认值:cloud_ssd

cloud_efficiency
worker_system_disk_sizelong

Worker 节点系统盘大小,单位为 GiB。

取值范围:[40,500]。

该参数的取值必须大于或者等于 max{40, ImageSize}。

默认值:120

120
worker_system_disk_snapshot_policy_idstring

Worker 节点系统盘采用的自动快照策略 ID。

sp-2zej1nogjvovnz4z****
worker_system_disk_performance_levelstring

当系统盘为 ESSD 云盘时,可设置 ESSD 云盘的性能级别 PL(Performance Level)。更多信息,请参见 ESSD 云盘

取值:

  • PL0
  • PL1
  • PL2
  • PL3
PL1
worker_data_disksobject []

Worker 节点数据盘类型、大小等配置的组合。

categorystring

数据盘类型。

cloud_essd
encryptedstring

是否对数据盘加密。取值:

  • true:对数据盘加密。
  • false:不对数据盘加密。

默认值:false

true
sizestring

数据盘大小,取值范围:40~32767。

120
performance_levelstring

节点数据盘磁盘性能等级,仅对 ESSD 磁盘生效。磁盘性能等级和磁盘大小有关。更多信息,请参见 ESSD 云盘

PL1
worker_instance_charge_typestring

Worker 节点付费类型,取值:

  • PrePaid:包年包月。
  • PostPaid:按量付费。

默认值:按量付费。

PrePaid
worker_period_unitstring

Wroker 节点付费周期,当付费类型为PrePaid的时候需要指定周期。

取值:Month,当前只支持以月为周期。

Month
worker_periodlong

Worker 节点包年包月时长,当worker_instance_charge_type取值为PrePaid时才生效且为必选值。

取值范围:{1, 2, 3, 6, 12, 24, 36, 48, 60}。

默认值:1。

1
worker_auto_renewboolean

Worker 节点是否开启自动续费,当worker_instance_charge_type取值为PrePaid时才生效,取值:

  • true:自动续费。
  • false:不自动续费。

默认值:true

true
worker_auto_renew_periodlong

Worker 节点自动续费周期,当选择包年包月付费类型时才生效,且为必选值。

取值范围:{1, 2, 3, 6, 12}。

1
instancesarray

使用已经节点创建集群时,需要指定 ECS 实例列表,该实例会作为 Worker 节点加入集群。

说明 使用已有实例创建集群时,该字段必填。
string

使用已经节点创建集群时,需要指定 ECS 实例列表,该实例会作为 Worker 节点加入集群。

说明 使用已有实例创建集群时,该字段必填。
i-2ze4zxnm36vq00xn****
format_diskboolean

使用已有实例创建集群时,是否对实例进行数据盘挂载,取值:

  • true:将容器和镜像存储在数据盘,数据盘内原有数据将丢失,请注意备份数据。

  • false:不将容器和镜像存储在数据盘。

默认值:false

数据盘挂载规则:

  • 如果 ECS 已挂载数据盘,且最后一块数据盘的文件系统未初始化,系统会自动将该数据盘格式化为 ext4,用来存放内容/var/lib/docker、/var/lib/kubelet。
  • 如果 ECS 未挂载数据盘,则不会挂载新的数据盘。
false
keep_instance_nameboolean

使用已有实例创建集群时,是否保留实例名称。

  • true:保留。
  • false:不保留,会用系统规则进行替换。

默认值:true

true
service_discovery_typesarray

集群内服务发现类型,用于在ASK集群中指定服务发现方式。

  • CoreDNS:使用 Kubernetes 原生标准服务发现组件 CoreDNS,需要在集群部署一组容器用于 DNS 解析。默认采用两个 0.25 Core 512 MiB 规格的 ECI 实例。
  • PrivateZone:使用阿里云 PrivateZone 产品提供服务发现能力,需要开启 PrivateZone 服务。

默认值:不开启。

string

集群内服务发现类型,用于在ASK集群中指定服务发现方式。

  • CoreDNS:使用 Kubernetes 原生标准服务发现组件 CoreDNS,需要在集群部署一组容器用于 DNS 解析。默认采用两个 0.25 Core 512 MiB 规格的 ECI 实例。
  • PrivateZone:使用阿里云 PrivateZone 产品提供服务发现能力,需要开启 PrivateZone 服务。

默认值:不开启。

PrivateZone
nat_gatewayboolean

创建 ASK 集群时,是否在 VPC 中创建 NAT 网关并配置 SNAT 规则。取值:

  • true:将为您创建 NAT 网关并自动配置 SNAT 规则,集群 VPC 将具备公网访问能力。
  • false:不为您创建 NAT 网关及 SNAT 规则。集群 VPC 将不具备公网访问能力。

默认值:false

true
zone_idstring

集群所属地域的可用区 ID。此参数为 ASK 集群特有参数。

当创建 ASK 集群时,如果未指定vpc_idvswitch_ids,必须为集群指定zone_id,用于自动在该可用区创建 VPC 网络资源。

cn-beiji****
profilestring

当您选择cluster_typeManagedKubernetes时,即 ACK 托管类的集群时,您可以进一步指定集群的子类型。

  • Default:ACK 托管集群,包括 ACK 集群 Pro 版和 ACK 集群基础版。
  • Edge:ACK Edge 集群,包括 ACK Edge 集群 Pro 版和 ACK Edge 集群基础版。
  • Serverless:ACK Serverless 集群,包括 ACK Serverless 集群 Pro 版和 ACK Serverless 集群基础版。
  • Lingjun:ACK 灵骏集群,提供 Pro 版。
Default
logging_typestring

集群开启日志服务,只针对 ACK Serverless 集群生效,且取值必须是SLS

SLS
controlplane_log_ttlstring

控制平面组件日志保存天数。

30
controlplane_log_projectstring

控制平面组件日志服务 Project,可以使用已有 Project 用于日志存储,也可以使用系统自动创建 Project 用户日志存储。如果选择自动创建日志服务 Project 将会自动创建一个名称为k8s-log-{ClusterID}的日志服务 Project。

k8s-log-xxx
controlplane_log_componentsarray

组件名称列表,指定那些控制平面的组件日志需要被收集。

默认采集 apiserver、kcm、scheduler 组件的日志。

string

组件名称列表,指定那些控制平面的组件日志需要被收集。

默认采集 apiserver、kcm、scheduler 组件的日志。

["apiserver","kcm","scheduler"]
deletion_protectionboolean

集群删除保护,防止通过控制台或 API 误删除集群。取值:

  • true:启用集群删除保护,将不能通过控制台或 API 删除集群。
  • false:不启用集群删除保护,则能通过控制台或 API 删除集群。

默认值:false

true
disable_rollbackboolean

集群创建失败是否回滚。取值:

  • true:当集群创建失败时,进行回滚操作。
  • false:当集群创建失败时,不进行回滚操作。

默认值:true

true
timeout_minslong

集群创建超时时间,单位分钟。

默认值:60

60
image_typestring

操作系统发行版类型,推荐使用该字段指定节点操作系统。取值:

  • CentOS
  • AliyunLinux
  • AliyunLinux Qboot
  • AliyunLinuxUEFI
  • AliyunLinux3
  • Windows
  • WindowsCore
  • AliyunLinux3Arm64
  • ContainerOS

默认值:CentOS

AliyunLinux
load_balancer_specstring

负载均衡规格,取值:

  • slb.s1.small
  • slb.s2.small
  • slb.s2.medium
  • slb.s3.small
  • slb.s3.medium
  • slb.s3.large

默认值:slb.s2.small

slb.s2.small
enable_rrsaboolean

是否启用 RRSA 功能。

true
resource_group_idstring

集群所属资源组 ID,实现不同资源的隔离。

rg-acfm3mkrure****
charge_typestring

集群付费类型,如下资源的计费方式属于包年包月计费类型:

节点池的节点(ECS)。

API Server 的私网 SLB 实例。

取值:

PrePaid:包年包月。

PostPaid:按量付费。

默认值:PostPaid。

PostPaid
period_unitstring

付费周期,当付费类型为 PrePaid 的时候,需要指定周期。

取值:Month,当前仅支持以月为周期。

Month
periodlong

购买时长。包年包月时长,当 charge_type 取值为 PrePaid 时才生效,且为必选值。

取值范围:{1, 2, 3, 6, 12, 24, 36, 48, 60}。

默认值:1。

1
ip_stackstring

集群 IP Stack。

可选值:IPv4(单栈)dual(双栈),默认值为IPv4。
nodepoolsarray

节点池列表。

nodepool

节点池配置。

access_control_listarray

注册集群 API Server SLB 访问控制列表。

string

注册集群 API Server SLB 访问控制列表。

192.168.1.0/24

返回参数

名称类型描述示例值
object

返回体。

cluster_idstring

集群 ID。

cb95aa626a47740afbf6aa099b650****
request_idstring

请求 ID。

687C5BAA-D103-4993-884B-C35E4314A1E1
task_idstring

任务 ID。

T-5a54309c80282e39ea00002f

示例

正常返回示例

JSON格式

{
  "cluster_id": "cb95aa626a47740afbf6aa099b650****",
  "request_id": "687C5BAA-D103-4993-884B-C35E4314A1E1",
  "task_id": "T-5a54309c80282e39ea00002f"
}

示例

正常返回示例

JSON格式

{
    "cluster_id": "cb95aa626a47740afbf6aa099b650****",
    "task_id": "T-5a54309c80282e39ea00002f",
    "request_id": "687C5BAA-D103-4993-884B-C35E4314A1E1"
}

XML格式

<cluster_id>cb95aa626a47740afbf6aa099b650****</cluster_id>
<task_id>T-5a54309c80282e39ea00002f</task_id>
<request_id>687C5BAA-D103-4993-884B-C35E4314A1E1</request_id>

错误码

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

变更历史

变更时间变更内容概要操作
2023-08-21API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2023-08-08API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2022-09-23API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2022-08-02API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
2021-11-24API 内部配置变更,不影响调用看变更集
变更项变更内容
API 内部配置变更,不影响调用
  • 本页导读 (1)
文档反馈