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

请求信息

请求行RequestLine

POST /clusters HTTP/1.1

特有请求头RequestHead

无,请参考公共请求头部

请求体RequestBody

说明 创建集群时,请求参数需要正确组合,否则会导致集群创建失败。在容器服务控制台创建集群界面,提供了生成集群创建OpenAPI参数功能,可以为您提供准确的参数组合。请参见生成 OpenAPI 参数
{
    "disable_rollback": "失败是否回滚",
    "name": "集群名称",
    "timeout_mins": "集群创建超时时间",
    "cluster_type": "集群类型,Kubernetes",
    "region_id": "地域",
    "vpcid": "VPC ID",
    "master_vswitch_ids": "master节点交换机ID。填写3个vswitchid, 尽量是分别在3个不同az, 保证高可用",
    "master_instance_types": "master节点实例类型。填写3个实例规格",
    "master_count": "master实例个数,支持3|5",
    "container_cidr": "容器POD CIDR",
    "service_cidr": "服务CIDR",
    "ssh_flags": "是否开放公网SSH登录",
    "cloud_monitor_flags": "是否安装云监控插件",
    "login_password": "节点SSH登录密码,和key_pair二选一",
    "key_pair": "keypair名称,和login_password 二选一",
    "master_instance_charge_type": "Master实例付费类型,PostPaid|PrePaid",
    "master_period_unit": "包年包月单位,Month,Year,只有在PrePaid下生效",
    "master_period": "包年包月时长,只有在PrePaid下生效",
    "master_auto_renew": "Master节点是否自动续费",
    "master_auto_renew_period": "Master节点续费周期",
    "master_system_disk_category": "Master系统盘类型",
    "master_system_disk_size": "Master节点系统盘大小",
    "master_data_disk(已弃用)": "Master节点是否挂载数据盘",
    "master_data_disks": "Master节点数据盘配置",
    "master_system_disk_snapshot_policy_id": "Master节点系统盘快照策略ID",
    "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_vswitch_ids": "一台或多台虚拟交换机 ID,N 的取值范围为 [1, 5]",
    "worker_system_disk_category": "Worker系统盘类型",
    "worker_system_disk_size": "Worker节点系统盘大小",
    "worker_data_disk(已弃用)": "Worker节点是否挂载数据盘",
    "worker_data_disks": "Worker节点数据盘配置",
    "worker_system_disk_snapshot_policy_id": "Worker节点系统盘快照策略ID",
    "num_of_nodes": "Worker节点数",
    "snat_entry": "是否配置SNATEntry",
    "endpoint_public_access": "是否公网暴露集群endpoint",
    "cpu_policy": "static|none",
    "node_port_range": "节点端口范围,默认30000-65535",
    "proxy_mode": "网络模式, 可选值iptables|ipvs",
    "addons": "选装addon, 数组格式对象", 
    "tags": "给集群打tag标签, 数组格式对象",
    "security_group_id": "安全组ID",
    "auto_snapshot_policy_id": "自动快照策略ID",
    "taints": "给节点添加taint, 数组格式对象",
    "deletion_protection":"是否开启集群删除保护,防止通过控制台或api误删除集群",
    "os_type":"运行pod的主机的操作系统类型,例如:linux,Windows等",
    "platform":"运行pod的主机的平台架构",
    "runtime":"容器运行时,默认为docker",
}
表 1. 请求体解释
名称 类型 必须 描述
cluster_type string 集群类型。
key_pair string keypair名称。和login_password二选一。
login_password string SSH登录密码。密码规则为8 - 30 个字符,且至少同时包含三项(大小写字母、数字和特殊符号)。和key_pair 二选一。
master_instance_charge_type string Master节点付费类型,可选值为:
  • PrePaid:预付费
  • PostPaid:按量付费
默认为按量付费。
master_instance_types list Master节点ECS规格类型代码。更多详细信息,参见实例规格族
master_system_disk_category string Master节点系统盘类型,取值范围是:
  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD云盘。
master_system_disk_size int Master节点系统盘大小,单位为GiB。
master_vswitch_ids list Master节点交换机ID列表,交换机个数取值范围为1~3。为确保集群的高可用性,推荐您选择3个交换机,且分布在不同的可用区。
num_of_nodes int Worker节点数。范围是[0,100]。
name string 集群名称, 集群名称可以使用大小写英文字母、中文、数字、中划线。
region_id string 集群所在地域ID。
snat_entry bool 是否为网络配置SNAT。
  • 当已有VPC能访问公网环境时,设置为 false。
  • 当已有VPC不能访问公网环境时:
    • 设置为true,表示配置SNAT,此时可以访问公网环境。
    • 设置为false,表示不配置SNAT,此时不能访问公网环境。
worker_instance_types list Worker 节点 ECS 规格类型代码。更多详细信息,参见实例规格族
worker_system_disk_category string Worker节点系统盘类型。
worker_system_disk_size int Worker节点系统盘大小,单位为GiB。
worker_vswitch_ids list Worker节点的虚拟交换机 ID。
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 是否安装云监控插件:
  • true:表示安装。
  • false:表示不安装。。
cpu_policy string CPU策略。集群版本为1.12.6及以上版本支持static 和 none两种策略。默认为none。
disable_rollback bool 失败是否回滚:
  • true:表示失败不回滚。
  • false:表示失败回滚。
默认为true,如果选择失败回滚,则会释放创建过程中所生产的资源,不推荐使用false。
master_auto_renew bool Master节点是否自动续费,当master_instance_charge_type取值为PrePaid时才生效,可选值为:
  • true:自动续费。
  • false:不自动续费。
master_auto_renew_period int 自动续费周期,当选择预付费和自动续费时才生效,且为必选值。PeriodUnit=Month时,取值为{“1”, “2”, “3”, “6”, “12”}。
master_count int Master实例个数,可选值3或者5。默认值为3。
master_data_disk(已弃用) bool Master节点是否挂载数据盘,可选择为:
  • true:挂载数据盘
  • false:不挂载数据盘,默认为false
master_data_disks list Master数据盘类型、大小等配置的组合。该参数只有在挂载Master节点数据盘时有效,包含以下参数:
  • category:数据盘类型。取值范围:
    • cloud:普通云盘
    • cloud_efficiency:高效云盘
    • cloud_ssd:SSD云盘
  • size:数据盘大小,单位为GiB。
  • encrypted:
master_period int 包年包月时长,当master_instance_charge_type取值为PrePaid时才生效且为必选值,取值范围: PeriodUnit=Month时,Period取值:{ “1”, “2”, “3”,“6”,“12”}。
master_period_unit string 当指定为PrePaid的时候需要指定周期。Month:以月为计时单位。
node_port_range string 节点服务端口。取值范围为[30000,65535]。
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网段。
ssh_flags bool 是否开放公网SSH登录:
  • true:表示开放。
  • false:表示不开放。
tags list 给集群打tag标签:
  • key:标签名称。
  • value:标签值。
taints list 用于给节点做污点标记,通常用于 Pods 的调度策略。与之相对应的概念为:容忍(tolerance),若 Pods 上有相对应的 tolerance 标记,则可以容忍节点上的污点,并调度到该节点。
kubernetes_version string Kubernetes集群版本,默认最新版。ACK支持的KubernetesK8s版本:v1.16.6,v1.14.6和v1.12.6。
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 自动续费周期,当选择预付费和自动续费时才生效,且为必选值: 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。
  • encrypted:是否对数据盘加密,true|false。
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:以月为计时单位。
deletion_protection bool 是否开启集群删除保护,防止通过控制台或api误删除集群。
os_type string 运行pod的主机的操作系统类型,例如:linux,Windows等。
platform string 运行pod的主机的平台架构。
runtime json 容器运行时,一般为docker,包括2个信息:name和version。
node_cidr_mask string 节点网络的网络前缀。node_cidr_mask通过cidr限制一个节点上能运行容器网络的Pod数量。例如node_cidr_mask是24的话,对应的容器数量是256,25对应的就是128。计算方式:2^(node_cidr_mask的值-24)-1。

返回信息

返回行 ResponseLine

HTTP/1.1 202 Accepted

特有返回头 ResponseHead

无,请参考公共返回头部

表 2. 返回体 ResponseBody
名称 类型 描述
cluster_id string 集群实例ID。
request_id string 请求ID。
task_id string 任务ID。系统自动分配,用户查询任务状态。

示例

请求示例

POST /clusters HTTP/1.1
<公共请求头>
{
"cluster_type":"Kubernetes",
"name":"my-test-Kubernetes-cluster",
"region_id":"cn-beijing",
"disable_rollback":true,
"timeout_mins":60,
"kubernetes_version":"1.12.6-aliyun.1",
"snat_entry":true,
"endpoint_public_access":false,
"cloud_monitor_flags":false,
"node_cidr_mask":"25",
"proxy_mode":"iptables",
"tags":[],
"addons": [{"name": "flannel"},{"name": "aliyun-log-controller","config": "{\"sls_project_name\":\"k8s-log-c64f6eab6a1764d3dbee3dc2b9e41****\"}"},{"name": "nginx-ingress-controller", "config": "{\"IngressSlbNetworkType\":\"internet\"}"}],
"node_port_range":"30000-32767",
"login_password":"test****",
"cpu_policy":"none",
"master_count":3,
"master_vswitch_ids":["vsw-2ze48rkq464rsdts****","vsw-2ze48rkq464rsdts1****","vsw-2ze48rkq464rsdts1****"],
"master_instance_types":["ecs.sn1.medium","ecs.sn1.medium","ecs.sn1.medium"],
"master_system_disk_category":"cloud_efficiency",
"master_system_disk_size":40,
"worker_instance_types":["ecs.sn2.3xlarge"],
"num_of_nodes":3,
"worker_system_disk_category":"cloud_efficiency",
"worker_system_disk_size":120,
"vpcid":"vpc-2zegvl5etah5requ0****",
"worker_vswitch_ids":["vsw-2ze48rkq464rsdts****"],
"container_cidr":"172.20.XX.XX/16",
"service_cidr":"172.21.XX.XX/20",
"worker_data_disks": [{"category": "cloud_ssd", "size": 500}],
"master_data_disks": [{"category": "cloud_ssd", "size": 500}],
"taints":[{"key": "special", "value": "true", "effect": "NoSchedule"}]
}

返回示例

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