调用CreateCluster创建一个新的Managed Kubernetes集群实例,并创建指定数量的节点。

请求信息

请求行RequestLine

POST /clusters HTTP/1.1 

特有请求头 RequestHead

无,请参考公共请求头部

请求体 RequestBody

说明 创建集群时,请求参数需要正确组合,否则会导致集群创建失败。在容器服务控制台创建集群界面,提供了生成集群创建OpenAPI参数功能,可以为您提供准确的参数组合。请参见生成 OpenAPI 参数
{
"disable_rollback": "失败是否回滚",
"name": "集群名称",
"timeout_mins": "集群创建超时时间",
"cluster_type": "集群类型,ManagedKubernetes",
"region_id": "地域",
"vpcid": "VPC ID",
"vswitch_ids": "一台或多台虚拟交换机 ID,N 的取值范围为 [1,3]",
"container_cidr": "容器POD CIDR。",
"service_cidr": "服务CIDR",
"cloud_monitor_flags":"是否安装云监控插件",
"login_password": "节点SSH登录密码,和key_pair二选一",
"key_pair":"keypair名称,和login_password 二选一",
"worker_instance_charge_type":"Worker节点付费类型PrePaid|PostPaid",
"worker_period_unit":"包年包月单位,Month,Year,只有在PrePaid下生效",
"worker_period":"包年包月时长,只有在PrePaid下生效",
"worker_auto_renew":"Worker节点自动续费true|false",
"worker_auto_renew_period":"Worker节点续费周期",
"worker_instance_types": "Worker实例规格多实例规格参数 ",
"worker_system_disk_category": "Worker系统盘类型",
"worker_system_disk_size": "Worker节点系统盘大小",
"worker_data_disk":"是否挂载数据盘 true|false",
"worker_data_disks":"Worker节点数据盘配置",
"num_of_nodes": "Worker节点数",
"snat_entry": "是否配置SNATEntry",
"endpoint_public_access":"是否公网暴露集群endpoint",
"proxy_mode": "网络模式, 可选值iptables|ipvs",
"addons": "选装addon, 数组格式对象", 
"tags": "给集群打tag标签, 数组格式对象",
"security_group_id": "安全组ID",
"taints": "给节点添加taint, 数组格式对象",
"cpu_policy":"cpu的策略,static|none",
"runtime":"容器的运行时环境,一般为docker",
"platform":"运行pod的主机的平台架构",
"os_type":"运行pod的主机的操作系统类型,例如:linux,Windows...",
"node_cidr_mask":"节点网络的网络ID的位数",
"kubernetes_version":"kubernetes集群的版本,默认最新版本",
"deletion_protection":"是否开启集群删除保护,防止通过控制台或api误删除集群"
}
表 1. 请求体解释
名称 类型 必须 描述
cluster_type string 集群类型。
key_pair string keypair名称。与login_password二选一。
login_password string SSH登录密码。密码规则为8 - 30 个字符,且至少同时包含三项(大小写字母、数字和特殊符号)。和key_pair 二选一。
name string 集群名称,集群名称可以使用大小写英文字母、中文、数字、中划线。
num_of_nodes int Worker节点数。范围是[0,100]。
region_id string 集群所在地域ID。
snat_entry bool 是否为网络配置SNAT。如果是自动创建VPC必须设置为true。如果使用已有VPC则根据是否具备出网能力来设置。
vswitch_ids list 交换机ID。List长度范围为 [1,3]。
worker_system_disk_category string Worker节点系统盘类型。
worker_system_disk_size int Worker节点系统盘大小。
addons list Kubernetes集群的addon插件的组合。
  • addons的参数:
    • name:必填,addon插件的名称。
    • version:可选,取值为空时默认取最新版本。
    • config:可选,取值为空时表示无需配置。
  • 网络插件:包含Flannel和Terway网络插件,二选一。
  • 日志服务:可选,如果不开启日志服务时,将无法使用集群审计功能。
  • Ingress:默认开启安装Ingress组件。
container_cidr string 容器网段,不能和VPC网段冲突。当选择系统自动创建VPC时,默认使用172.16.0.0/16网段。
cloud_monitor_flags bool 是否安装云监控插件。
disable_rollback bool 失败是否回滚:
  • true:表示失败不回滚。
  • false:表示失败回滚。
如果选择失败回滚,则会释放创建过程中所生产的资源,不推荐使用false
public_slb bool 是否开启公网API Server:
  • true:默认为True,表示开放公网API Server。
  • false:若设置为false, 则不会创建公网的API Server,仅创建私网的API Server。
说明 过期参数,替代参数请参见endpoint_public_access
proxy_mode string kube-proxy代理模式,支持iptables和IPVS两种模式。 默认为iptables。
endpoint_public_access bool 是否开启公网API Server:
  • true:默认为True,表示开放公网API Server。
  • false:若设置为false, 则不会创建公网的API Server,仅创建私网的API Server。
security_group_id string 指定集群ECS实例所属于的安全组ID。
service_cidr string 服务网段,不能和VPC网段以及容器网段冲突。当选择系统自动创建VPC时,默认使用172.19.0.0/20网段。
tags list 给集群打tag标签:
  • key:标签名称。
  • value:标签值。
taints list 用于给节点做污点标记,通常用于 Pods 的调度策略。与之相对应的概念为:容忍(tolerance),若 Pods 上有相对应的 tolerance 标记,则可以容忍节点上的污点,并调度到该节点。
timeout_mins int 集群资源栈创建超时时间,以分钟为单位,默认值 60分钟。
vpcid string VPC ID,可空。如果不设置,系统会自动创建VPC,系统创建的VPC网段为192.168.0.0/16。 VpcId 和 vswitchid 只能同时为空或者同时都设置相应的值。
worker_auto_renew bool 是否开启Worker节点自动续费,可选值为:
  • true:自动续费。
  • false:不自动续费。
worker_auto_renew_period int 自动续费周期,当worker_instance_charge_type取值为PrePaid时才生效且为必选值。PeriodUnit=Month时,取值为{“1”,“2”,“3”,“6”,“12”}。
worker_data_disk string 是否挂载数据盘,可选择:
  • true:表示worker节点挂载数据盘。
  • false:表示worker节点不挂载数据盘。
worker_data_disks list Worker数据盘类型、大小等配置的组合。该参数只有在挂载Worker节点数据盘时有效,包含以下参数:
  • category:数据盘类型。取值范围:
    • cloud:普通云盘。
    • cloud_efficiency:高效云盘。
    • cloud_ssd:SSD云盘。
  • size:数据盘大小,单位为GiB。
worker_data_disk_category int 数据盘类型
说明 过期参数,替代参数请参见worker_data_disks参数中的category取值。
worker_data_disk_size string 数据盘大小
说明 过期参数,替代参数请参见worker_data_disks参数中的size取值。
worker_instance_charge_type string Worker节点付费类型,可选值为:
  • PrePaid:预付费。
  • PostPaid:按量付费。
worker_period int 包年包月时长,当worker_instance_charge_type取值为PrePaid时才生效且为必选值。PeriodUnit=Month时,Period取值:{ “1”,“2”,“3”,“6”,“12”} 。
worker_period_unit string 当指定为PrePaid的时候需要指定周期。
说明 Month:以月为计时单位。
worker_instance_types list Worker 节点 ECS 规格类型代码。更多详细信息,参见实例规格族
cpu_policy string CPU策略。集群版本为1.12.6及以上版本支持static 和 none两种策略。默认为none。
runtime json 容器运行时,一般为docker,包括2个信息
  • name:容器运行时名称。
  • version:容器运行时版本。
platform string 运行Pod的主机的平台架构。
os_type string 运行Pod的主机的操作系统类型,例如Linux,Windows。
node_cidr_mask int 节点网络的网络前缀。node_cidr_mask通过cidr限制一个节点上能运行容器网络的Pod数量。例如node_cidr_mask是24的话,对应的容器数量是256,25对应的就是128。计算方式:2^(node_cidr_mask的值-24)-1。
kubernetes_version string Kubernetes集群的版本,默认最新版本。
deletion_protection bool 是否开启集群删除保护,防止通过控制台或API误删除集群。

返回信息

返回行 ResponseLine

HTTP/1.1 202 Accepted

特有返回头 ResponseHead

无,请参考公共返回头部

返回体 ResponseBody

{
"cluster_id":"string",
"request_id":"string",
"task_id":"string"
}

示例

请求示例

POST /clusters HTTP/1.1
<公共请求头>
{
"name":"test",
"cluster_type":"my-test-Kubernetes-cluster",
"disable_rollback":true,
"timeout_mins":60,
"kubernetes_version":"1.12.6-aliyun.1",
"region_id":"cn-beijing",
"snat_entry":true,
"cloud_monitor_flags":false,
"endpoint_public_access":false,
"node_cidr_mask":"25",
"proxy_mode":"ipvs",
"tags":[],
"addons": [{"name": "flannel"},{"name": "aliyun-log-controller","config": "{\"sls_project_name\":\"k8s-log-c64f6eab6a1764d3dbee3dc2b9e41****\"}"},{"name": "nginx-ingress-controller", "config": "{\"IngressSlbNetworkType\":\"internet\"}"}],
"worker_instance_types":["ecs.hfc5.xlarge"],
"num_of_nodes":3,
"worker_system_disk_category":"cloud_efficiency",
"worker_system_disk_size":120,
"worker_instance_charge_type":"PostPaid",
"vpcid":"vpc-2zegvl5etah5requ09nec",
"container_cidr":"172.20.0.0/16",
"service_cidr":"172.21.0.0/20",
"vswitch_ids":["vsw-2ze48rkq464rsdts1****"],
"worker_data_disks": [{"category": "cloud_ssd", "size": 500}],
"login_password":"test@19****",
"taint":[{"key": "special", "value": "true", "effect": "NoSchedule"}]
}

返回示例

HTTP/1.1 202 Accepted
<公共响应头>
{
    "cluster_id": "cb95aa626a47740afbf6aa099b65****",
    "request_id": "687C5BAA-D103-4993-884B-C35E4314A1E1",
    "task_id": "T-5a54309c80282e39ea00002f"
}