Container Service for Kubernetes:CreateCluster

The custom cluster name. The name must be 1 to 63 characters in length and can contain digits, Chinese characters, letters, and hyphens (-). It cannot start with a hyphen (-).

The region ID of the cluster. For more information, see Regions supported by Container Service.

• Kubernetes: ACK dedicated cluster.

• ManagedKubernetes: ACK managed cluster types, including ACK managed clusters (Pro and Basic), ACK Serverless clusters (Pro and Basic), ACK Edge clusters (Pro and Basic), and ACK Lingjun clusters (Pro).

• ExternalKubernetes: registered cluster.

After you set cluster_type to ManagedKubernetes and configure profile, you can further specify the cluster specification. Valid values:

• ack.standard: Basic (selected by default when the value is empty)

• ack.pro.small: Pro

• ack.pro.xlarge: Pro XL

• ack.pro.2xlarge: Pro 2XL

• ack.pro.4xlarge: Pro 4XL (requires contacting customer service to enable the whitelist)

Pro XL, Pro 2XL, and Pro 4XL are three tiers provided by ACK Pro Provisioned Control Plane. By pre-allocating and fixing control plane resources, they ensure that API concurrency and Pod scheduling capabilities remain at a deterministic high level, suitable for AI training and inference, ultra-large-scale clusters, and mission-critical workloads.

For information about the management fees for Pro and Provisioned Control Plane clusters, see Cluster management fee.

When you set cluster_type to ManagedKubernetes (ACK managed cluster types), you can further specify the cluster subtype.

• Default: ACK managed cluster, including ACK clusters (Pro and Basic).

• Edge: ACK Edge cluster, including ACK Edge clusters (Pro and Basic).

• Serverless: ACK Serverless cluster, including ACK Serverless clusters (Pro and Basic).

• Lingjun: ACK Lingjun cluster, available in Pro.

The cluster version, which is consistent with the Kubernetes community baseline version. We recommend that you select the latest version. If you do not specify this parameter, the latest version is used by default.

You can create clusters of the latest three versions. Call the DescribeKubernetesVersionMetadata operation to query supported cluster versions.

For more information about Kubernetes versions supported by ACK, see Kubernetes version release overview.

The resource group ID of the cluster, used to isolate different resources.

Specifies whether to enable cluster deletion protection, which prevents the cluster from being accidentally deleted through the console or API. Valid values:

• true: Enable cluster deletion protection. The cluster cannot be deleted through the console or API.

• false: Do not enable cluster deletion protection. The cluster can be deleted through the console or API.

Default value: false.

The VPC used by the cluster. You must provide a VPC when creating a cluster.

The IP protocol stack of the cluster.

The Pod network CIDR block. It must be a valid private CIDR block, specifically the following CIDR blocks and their subnets: 10.0.0.0/8, 172.16-31.0.0/12-16, 192.168.0.0/16. It cannot overlap with the VPC CIDR block or CIDR blocks used by existing Kubernetes clusters in the VPC. It cannot be modified after creation.

For information about cluster network planning, see ACK managed cluster network planning.

The Service network CIDR block. Valid ranges: 10.0.0.0/16-24, 172.16-31.0.0/16-24, 192.168.0.0/16-24. It cannot overlap with the VPC CIDR block 10.1.0.0/21 or CIDR blocks used by existing Kubernetes clusters in the VPC. It cannot be modified after creation.

Default value: 172.19.0.0/20.

The security group ID. Specify this parameter when creating a cluster with an existing security group. Mutually exclusive with is_enterprise_security_group. Cluster nodes are automatically added to this security group.

Specifies whether to use automatic creation of an advanced security group. Takes effect when security_group_id is empty.

• true: Create and use an advanced security group.

• false: Use a basic security group.

Default value: true.

Settings for configuring SNAT for the VPC. Valid values:

• true: Use automatic creation of a NAT gateway and configure SNAT rules. Set this to true if nodes and applications in the cluster need to access the Internet.

• false: Do not create a NAT gateway or SNAT rules. Nodes and applications in the cluster cannot access the Internet.

Default value: false.

Specifies whether to public network access. Exposes the API Server through an EIP to public network access to the cluster.

• true: Public network access.

• false: Do not public network access. If not enabled, the cluster API Server cannot be accessed from the Internet.

Default value: false.

The CLB instance ID for API Server access. When this parameter is specified, automatic creation of the API Server CLB is not performed.

Specifies whether to enable public SSH logon. Used to log on to the master nodes of ACK dedicated clusters. This parameter does not take effect for managed clusters.

• true: Enable.

• false: Do not enable.

Default value: false.

The time zone used by the cluster. See Supported time zones.

The number of IP addresses per node, determined by specifying the network CIDR mask. Only takes effect for Flannel network type clusters.

Default value: 26.

The kube-proxy mode.

• iptables: A mature and stable kube-proxy mode. Service discovery and load balancing for Kubernetes Services are configured using iptables rules. However, performance is average and significantly affected by scale. Suitable for clusters with a small number of Services.

• ipvs: A high-performance kube-proxy mode. Service discovery and load balancing for Kubernetes Services are configured using the Linux IPVS module. Suitable for clusters with a large number of Services that require high-performance load balancing.

• nftables: A next-generation kube-proxy mode that implements Service discovery and load balancing based on Linux nftables, serving as a modern replacement for iptables. Compared to iptables, nftables offers better network performance, more efficient rule updates, and improved behavior in large-scale Service scenarios.
  Only supported for clusters running version 1.35 or later. The Kubernetes community deprecated IPVS starting from version 1.35. For new clusters, use nftables for longer-term community support.
  
  

Default value: ipvs.

The number of days for log retention of control plane component logs.

The Simple Log Service project for control plane component logs. You can use an existing project for log storage or have the system automatically create a project. If you choose automatic creation, a Simple Log Service project named k8s-log-{ClusterID} is created.

The cluster local domain.

Naming rules: The domain consists of one or more parts separated by periods (.). Each part can be up to 63 characters in length and can contain lowercase letters, digits, and hyphens (-). Each part must start and end with a lowercase letter or digit.

The KMS key ID used to encrypt data disks. For more information, see Key Management Service.

A ServiceAccount is the access credential for communication between a Pod and the cluster API Server. The service-account-issuer is the issuer identity in the serviceaccount token, which is the iss field in the token payload.

For more information about ServiceAccount, see Deploy service account token volume projection.

A ServiceAccount is the access credential for communication between a Pod and the cluster API Server. The api-audiences is the valid request token identity, used by the apiserver to authenticate whether a request token is valid. Multiple audiences are supported, separated by commas (,).

For more information about ServiceAccount, see Deploy service account token volume projection.

The cluster maintenance window.

The custom cluster CA.

This field is deprecated. Use the extra_sans parameter instead.

The custom certificate Subject Alternative Name (SAN). Separate multiple IP addresses or domain names with commas (,).

The container runtime of the cluster. Supported runtimes include containerd, sandboxed containers, and Docker.

For more information, see Comparison among Docker, containerd, and sandboxed container runtimes.

This field is deprecated. For node pool configurations, use the node_name_mode parameter under kubernetes_config in nodepool instead.

This field is deprecated. The custom node data.

This field is deprecated. For control plane configurations, use the image_id parameter under control_plane_config instead. For node pool configurations, use the image_id parameter under scaling_group in nodepool instead.

The custom node image. The system image is used by default. When a custom image is selected, it replaces the default system image. For more information, see Custom images.

This field is deprecated. For control plane node configurations, use the cloud_monitor_flags parameter under control_plane_config instead. For node pool configurations, use the cms_enabled parameter under kubernetes_config in nodepool instead.

Specifies whether to install the CloudMonitor agent on the cluster. Valid values:

• true: Installs the CloudMonitor agent.

• false: Does not install the CloudMonitor agent.

Default value: false.

This field is deprecated. For node pool configurations, use the platform parameter under scaling_group in nodepool instead.

The operating system distribution. Valid values:

• CentOS

• AliyunLinux

• QbootAliyunLinux

• Qboot

• Windows

• WindowsCore

Default value: CentOS.

This field is deprecated. For control plane node configurations, use the image_type parameter under control_plane_config instead. For node pool configurations, use the image_type parameter under scaling_group in nodepool instead.

The operating system platform type. Valid values:

• Windows

• Linux

Default value: Linux.

This field is deprecated. For control plane node configurations, use the soc_enabled parameter under control_plane_config instead. For node pool configurations, use the soc_enabled parameter under scaling_group in nodepool instead.

MLPS 2.0 security hardening. For more information, see ACK MLPS 2.0 security hardening usage instructions.

Valid values:

• true: Enables MLPS 2.0 security hardening.

• false: Does not enable MLPS 2.0 security hardening.

Default value: false.

This field is deprecated. For control plane configurations, use the security_hardening_os parameter under control_plane_config instead. For node pool configurations, use the security_hardening_os parameter under scaling_group in nodepool instead.

Alibaba Cloud OS security hardening. Valid values:

• true: Enables Alibaba Cloud OS security hardening.

• false: Does not enable Alibaba Cloud OS security hardening.

Default value: false.

This field is deprecated. For control plane configurations, use the security_hardening_os parameter under control_plane_config instead. For node pool configurations, use the security_hardening_os parameter under scaling_group in nodepool instead.

This field is deprecated. For control plane configurations, use the cpu_policy parameter under control_plane_config instead. For node pool configurations, use the cpu_policy parameter under kubernetes_config in nodepool instead.

The node CPU management policy. The following policies are supported for cluster versions 1.12.6 and later:

• static: Allows pods with certain resource characteristics on the node to be granted enhanced CPU affinity and exclusivity.

• none: Uses the existing default CPU affinity scheme.

Default value: none.

The node service port range. Valid values: [30000,65535].

Default value: 30000-32767.

This field is deprecated. For control plane configurations, use the key_pair parameter under control_plane_config instead. For node pool configurations, use the key_pair parameter under scaling_group in nodepool instead.

The key pair name. Mutually exclusive with login_password.

This field is deprecated. For control plane configurations, use the login_password parameter under control_plane_config instead. For node pool configurations, use the login_password parameter under scaling_group in nodepool instead.

The SSH logon password. Mutually exclusive with key_pair. The password must be 8 to 30 characters in length and contain at least three of the following character types: uppercase letters, lowercase letters, digits, and special characters.

This field is deprecated. For control plane configurations, use the size parameter under control_plane_config instead.

The number of master nodes. Valid values: 3 or 5.

Default value: 3.

This field is deprecated. For control plane configurations, use the system_disk_category parameter under control_plane_config instead.

The system cloud disk type for master nodes. Valid values:

• cloud_efficiency: ultra cloud disk.

• cloud_ssd: standard SSD.

• cloud_essd: ESSD.

Default value: cloud_ssd. The default value may vary by zone.

This field is deprecated. For control plane configurations, use the system_disk_size parameter under control_plane_config instead.

The system cloud disk size for master nodes. Valid values: [40,500]. Unit: GiB.

Default value: 120.

This field is deprecated. For control plane configurations, use the system_disk_performance_level parameter under control_plane_config instead.

The performance level of the system cloud disk for cluster master nodes. This parameter takes effect only for ESSD cloud disks. The performance level varies based on the cloud disk size. For more information, see ESSD cloud disks.

This field is deprecated. For control plane configurations, use the system_disk_snapshot_policy_id parameter under control_plane_config instead.

The automatic snapshot policy ID for the master node system cloud disk.

This field is deprecated. For control plane configurations, use the instance_charge_type parameter under control_plane_config instead.

The billing method for master nodes. Valid values:

• PrePaid: subscription.

• PostPaid: pay-as-you-go.

Default value: PostPaid.

This field is deprecated. For control plane configurations, use the period_unit parameter under control_plane_config instead.

The billing period unit for master nodes. This parameter is required when the billing method is PrePaid.

Valid values: Month. Only monthly billing is supported.

This field is deprecated. For control plane configurations, use the unit parameter under control_plane_config instead.

The subscription duration for master nodes. This parameter takes effect and is required only when master_instance_charge_type is set to PrePaid.

Valid values: {1, 2, 3, 6, 12, 24, 36, 48, 60}.

Default value: 1.

This field is deprecated. For control plane configurations, use the auto_renew parameter under control_plane_config instead.

Specifies whether to enable auto-renewal for master nodes. This parameter takes effect only when master_instance_charge_type is set to PrePaid. Valid values:

• true: Enables auto-renewal.

• false: Disables auto-renewal.

Default value: true.

This field is deprecated. For control plane configurations, use the auto_renew_period parameter under control_plane_config instead.

The auto-renewal period for master nodes. This parameter takes effect and is required when the subscription billing method is selected.

Valid values: {1, 2, 3, 6, 12}.

Default value: 1.

This field is deprecated. For node pool configurations, use the desired_size parameter under scaling_group in nodepool instead.

The number of worker nodes. Valid values: [0, 100].

This field is deprecated. For node pool configurations, use the system_disk_category parameter under scaling_group in nodepool instead.

The system cloud disk type for worker nodes. For more information, see Block storage overview.

Valid values:

• cloud_efficiency: ultra cloud disk.

• cloud_ssd: standard SSD.

Default value: cloud_ssd.

This field is deprecated. For node pool configurations, use the system_disk_size parameter under scaling_group in nodepool instead.

The system cloud disk size for worker nodes. Unit: GiB.

Valid values: [40,500].

The value must be greater than or equal to max{40, ImageSize}.

Default value: 120.

This field is deprecated. For node pool configurations, use the system_disk_snapshot_policy_id parameter under scaling_group in nodepool instead.

The automatic snapshot policy ID for the worker node system cloud disk.

This field is deprecated. For node pool configurations, use the system_disk_performance_level parameter under scaling_group in nodepool instead.

When the system cloud disk is an ESSD, you can set the performance level (PL) of the ESSD. For more information, see ESSD cloud disks.

Valid values:

• PL0

• PL1

• PL2

• PL3

This field is deprecated. For node pool configurations, use the instance_charge_type parameter under scaling_group in nodepool instead.

The billing method for worker nodes. Valid values:

• PrePaid: subscription.

• PostPaid: pay-as-you-go.

Default value: pay-as-you-go.

This field is deprecated. For node pool configurations, use the period_unit parameter under scaling_group in nodepool instead.

The billing period unit for worker nodes. This parameter is required when the billing method is PrePaid.

Valid values: Month. Only monthly billing is supported.

This field is deprecated. For node pool configurations, use the period parameter under scaling_group in nodepool instead.

The subscription duration for worker nodes. This parameter takes effect and is required only when `worker_

【该字段已废弃】节点池配置请使用nodepool中scaling_group下的auto_renew参数代替。

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

• true：自动续费。

• false：不自动续费。

默认值：true。

【该字段已废弃】节点池配置请使用nodepool中scaling_group下的auto_renew_period参数代替。

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

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

【该字段已废弃】创建集群时不支持选择已有节点，如需添加已有节点到集群，请先创建节点池，并调用 AttachInstancesToNodePool 接口操作。

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

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

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

默认值：false。

数据盘挂载规则：

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

• 如果 ECS 未挂载数据盘，则不会挂载新的数据盘。

【该字段已废弃】创建集群时不支持选择已有节点，如需添加已有节点到集群，请先创建节点池，并调用 AttachInstancesToNodePool 接口操作。

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

• true：保留。

• false：不保留，会用系统规则进行替换。

默认值：true。

【该字段已废弃】请使用参数snat_entry代替。

【该字段已废弃】请使用zone_ids参数代替。

集群所属地域的可用区 ID。此参数为 ACK 托管类的集群特有参数。

当创建 ACK 托管类的集群时，如果未指定vpc_id和vswitch_ids，必须为集群指定zone_id，用于自动在该可用区创建 VPC 网络资源；指定vpc_id和vswitch_ids时，该参数无效。

【该字段已废弃】集群开启日志服务，只针对 ACK Serverless 集群生效，且取值必须是SLS。

【该字段已废弃】集群创建失败时默认不会进行回滚，您需要自行清理创建失败的集群。

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

• true：当集群创建失败时，进行回滚操作。

• false：当集群创建失败时，不进行回滚操作。

默认值：true。

【该字段已废弃】集群创建失败时默认不会进行回滚，您需要自行清理创建失败的集群。

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

默认值：60。

【该字段已废弃】集群控制面配置请使用control_plane_config下的image_type参数代替；节点池配置请使用nodepool中scaling_group下的image_type参数代替。

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

• CentOS

• AliyunLinux

• AliyunLinux Qboot

• AliyunLinuxUEFI

• AliyunLinux3

• Windows

• WindowsCore

• AliyunLinux3Arm64

• ContainerOS

默认值：CentOS。

【该参数已废弃】CLB 按使用量计费，该参数不生效。

负载均衡规格，取值：

• slb.s1.small

• slb.s2.small

• slb.s2.medium

• slb.s3.small

• slb.s3.medium

• slb.s3.large

默认值：slb.s2.small。

【该字段已废弃】请使用参数rrsa_config代替。

是否启用 RRSA 功能。

• true：开启。

• false：不开启。

【该字段已废弃】

API Server 所使用的 CLB 实例的付费类型，默认值为 PostPaid。取值：

• PostPaid：按量付费。

• PrePaid：包年包月，新建 CLB 付费类型已不支持，存量不影响。

【该字段已废弃】

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

取值：Month，当前仅支持以月为周期。

该字段于 2024 年 10 月 15 日存在变更，更多信息，请参见关于集群创建接口 CreateCluster 参数行为变更的公告。

【该字段已废弃】

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

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

默认值：1。

该字段于 2024 年 10 月 15 日存在变更，更多信息，请参见关于集群创建接口 CreateCluster 参数行为变更的公告。

【该字段已废弃】

是否开启自动续费，当charge_type取值为PrePaid时才生效。取值：

• true：自动续费。

• false：不自动续费。

默认值：false。

该字段于 2024 年 10 月 15 日存在变更，更多信息，请参见关于集群创建接口 CreateCluster 参数行为变更的公告。

【该字段已废弃】

自动续费周期，当选择预付费和自动续费时才生效。当PeriodUnit=Month时，取值范围：{1, 2, 3, 6, 12}。

默认值：1。

该字段于 2024 年 10 月 15 日存在变更，更多信息，请参见关于集群创建接口 CreateCluster 参数行为变更的公告。

集群 ID。

请求 ID。

任务 ID。