调用CreateCluster创建一个标准托管版安全沙箱Kubernetes集群。

调试

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

请求语法

POST /clusters HTTP/1.1
Content-Type:application/json
{
  "addons" : [ {
    "name" : "String",
    "config" : "String",
    "disabled" : Boolean
  } ],
  "cloud_monitor_flags" : Boolean,
  "cluster_type" : "String",
  "container_cidr" : "String",
  "cpu_policy" : "String",
  "deletion_protection" : Boolean,
  "disable_rollback" : Boolean,
  "endpoint_public_access" : Boolean,
  "is_enterprise_security_group" : Boolean,
  "key_pair" : "String",
  "kubernetes_version" : "String",
  "login_password" : "String",
  "name" : "String",
  "node_cidr_mask" : "String",
  "node_port_range" : "String",
  "num_of_nodes" : Long,
  "pod_vswitch_ids" : [ "String" ],
  "proxy_mode" : "String",
  "region_id" : "String",
  "runtime" : {
    "name" : "String",
    "version" : "String"
  },
  "service_cidr" : "String",
  "security_group_id" : "String",
  "snat_entry" : Boolean,
  "ssh_flags" : Boolean,
  "tags" : [ {
    "key" : "String",
    "value" : "String"
  } ],
  "taints" : [ {
    "key" : "String",
    "value" : "String",
    "effect" : "String"
  } ],
  "timeout_mins" : Long,
  "user_data" : "String",
  "vpcid" : "String",
  "vswitch_ids" : [ "String" ],
  "worker_auto_renew" : Boolean,
  "worker_auto_renew_period" : Long,
  "worker_data_disks" : [ {
    "category" : "String",
    "size" : Long,
    "encrypted" : "String",
    "auto_snapshot_policy_id" : "String"
  } ],
  "worker_vswitch_ids" : [ "String" ],
  "worker_instance_types" : [ "String" ],
  "worker_system_disk_category" : "String",
  "worker_system_disk_size" : Long,
  "worker_instance_charge_type" : "String",
  "worker_period_unit" : "String",
  "worker_period" : Long,
  "zone_id" : "String"
}
            

请求参数

表 1. 请求Body参数
名称 类型 是否必选 示例值 描述
addons Array [{"name": "terway-eniip","config": ""}, {"name": "logtail-ds","config": "{\"IngressDashboardEnabled\":\"true\",\"sls_project_name\":\"your_sls_project_name\"}"}, {"name":"nginx-ingress-controller","config":"{\"IngressSlbNetworkType\":\"internet\"}"}] Kubernetes集群的安装的组件列表:
  • 组件的参数:
    • name:必选。
    • config:可选,取值为空时表示无需配置。
    • disabled:可选,是否禁止默认安装。
  • 网络插件:必选,包含Flannel和Terway网络两种网络类型,创建集群时二选一。
    • Flannel网络:[{"name":"flannel","config":""}]
    • Terway网络:[{"name": "terway-eniip","config": "\"IPVlan\":\"false\""}]
  • 存储插件:必选,支持CSI和FlexVolume两种类型。
    • 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:可选,默认开启安装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\"}"}]

cloud_monitor_flags Boolean true 集群是否安装云监控插件。取值:
  • true:集群不安装云监控插件。
  • false:集群安装云监控插件。

默认值:false

cluster_type String ManagedKubernetes 集群类型。创建标准托管版安全沙箱集群时,只能选ManagedKubernetes
container_cidr String 172.20.0.0/16 Pod网络地址段,不能和VPC网段冲突。当选择系统自动创建VPC时,默认使用172.16.0.0/16网段。当创建Flannel网络类型的集群时,该字段为必选。
cpu_policy String none 节点CPU管理策略。当集群版本在1.12.6及以上时支持以下两种策略:
  • static:允许为节点上具有某些资源特征的Pod赋予增强的CPU亲和性和独占性。
  • none:表示启用现有的默认CPU亲和方案。

默认值:none

deletion_protection Boolean true 集群是否开启集群删除保护,防止通过控制台或API误删除集群。取值:
  • true:集群开启集群删除保护。
  • false:集群不开启集群删除保护。

默认值:false

disable_rollback Boolean true 集群创建失败是否回滚。取值:
  • true:集群创建失败回滚。
  • false:集群创建失败不回滚。

默认值:false

endpoint_public_access Boolean true 是否开启公网API Server。取值:
  • true:表示开放公网API Server。
  • false:表示不会创建公网的API Server,仅创建私网的API Server。

默认值:true

is_enterprise_security_group Boolean true 自动创建企业级安全组,当security_group_id为空时生效。Terway网络类型集群,必须指定为企业安全组。
  • true:自动创建企业级安全组。
  • false:不自动创建企业级安全组。
默认值:false
key_pair String secrity-key 密钥对名称,和login_password二选一。
kubernetes_version String 1.16.9-aliyun.1 集群版本,与Kubernetes社区基线版本保持一致。建议选择最新版本,若不指定,默认使用最新版本。目前您可以在ACK控制台创建两种最新版本的集群。您可以通过API创建其他Kubernetes版本集群。关于ACK支持的Kubernetes版本,请参见Kubernetes版本发布概览
login_password String Hello@1234 SSH登录密码,和key_pair二选一。密码规则为8~30个字符,且至少同时包含三项(大小写字母、数字和特殊符号)。
name String cluster-demo 集群名称。命名规则:由数字、汉字、英文字符或短划线(-)组成,长度范围1~63个字符,且不能以短划线(-)开头。
node_cidr_mask String 25 节点IP数量,通过指定网络的CIDR来确定IP的数量,只对于Flannel网络类型集群生效。

默认值:25。

node_port_range String 30000~32767 节点服务端口范围。取值范围为[30000,65535]。
num_of_nodes Long 3 Worker节点数。范围是[0,100]。
pod_vswitch_ids Array of String vsw-2ze97jwri7cei0mpw**** Pod的虚拟交换机列表。
说明 Terway网络类型必须要指定pod_vswitch_ids
您需要为每一个节点虚拟交换机指定至少一个相同可用区的Pod虚拟交换机,并且不能跟节点vswitch重复。
proxy_mode String ipvs kube-proxy代理模式,支持iptablesipvs两种模式。

默认为ipvs

region_id String cn-beijing 集群所在的地域ID。
runtime Object 集群内容器运行时。
注意 此参数为必选参数。
name Object Sandboxed-Container.runv 容器运行时版本。容器运行时名称。取值:
  • Sandboxed-Container.runv:安全沙箱运行时。
  • docker:Docker运行时。

默认:docker

注意 在创建安全沙箱集群的场景下,只能选Sandboxed-Container.runv
version Object 2.1.0 容器运行时版本,默认为最新版。关于安全沙箱运行时的变更详情,请参见安全沙箱运行时变更记录
security_group_id String sg-bp1bdue0qc1g7k**** 使用已有安全组创建集群时需要指定安全组ID,集群节点自动加入到此安全组,和is_enterprise_security_group二选一。
service_cidr String 172.21.0.0/20 Service网络地址段,不能和VPC网段及Pod网络网段冲突。当选择系统自动创建VPC时,默认使用172.19.0.0/20网段。
snat_entry Boolean true 是否为网络配置SNAT:
  • 当已有VPC能访问公网环境时,设置为false
  • 当已有VPC不能访问公网环境时:
    • 设置为true,表示配置SNAT,此时可以访问公网环境。
    • 设置为false,表示不配置SNAT,此时不能访问公网环境。

如果您的应用需要访问公网,建议配置为true

默认值:false

ssh_flags Boolean true 是否开放公网SSH登录。取值:
  • true:表示开放。
  • false:表示不开放。
默认值:false
tags Array 集群标签。
key String env 标签key-value的键。
value String prod 标签key-value的值。
taints Array 节点污点信息。污点和容忍度(Toleration)相互配合,可以用来避免Pod被分配到不合适的节点上。更多信息,请参见taint-and-toleration
effect String NoSchedule 调度策略。取值:
  • NoSchedule:Pod不会被调度到标记了Taints的节点上。
  • NoExecute:一旦Taint生效,该节点内正在运行的Pod没有对应Tolerate设置,会直接被逐出。
  • PreferNoSchedule:NoSchedule的宽松版本。避免将Pod调度到有污点的节点上。
key String disk_type 污点key-value的键。
value String sshd 污点key-value的值。
timeout_mins Long 60 集群创建超时时间。

默认值:60。

user_data String IyEvdXNyL2Jpbi9iYXNoCmVjaG8gIkhlbGxvIEFD**** 节点自定义数据。更多信息,请参见生成实例自定义数据
vpcid String vpc-2zeik9h3ahvv2zz95**** 集群使用的VPC实例ID。
vswitch_ids Array of String vsw-2ze48rkq464rsdts1****" 虚拟交换实例ID。
worker_auto_renew Boolean true Worker节点是否开启自动续费,当worker_instance_charge_type取值为PrePaid时才生效,可选值为:
  • true:自动续费。
  • false:不自动续费。
默认值:true。
worker_auto_renew_period Long 1 Worker节点自动续费周期,当选择包年包月付费类型时才生效,且为必选值。取值范围:{1,2,3,6,12}。
worker_data_disks Array Worker节点数据盘类型、大小等配置的组合。
auto_snapshot_policy_id String sp-bp14j6w7ss6ozz**** 自动快照策略ID。
category String cloud_ssd Worker节点数据盘类型,取值:
  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD云盘。
  • cloud:普通云盘。
默认值:cloud_efficiency
encrypted String false 是否对数据盘加密。取值:
  • true:对数据盘加密。
  • false:不对数据盘加密。

默认值:false

size String 200 数据盘大小,内存单位为GiB。取值范围:
  • cloud_efficiency:[20,32768]
  • cloud_ssd:[20,32768]
  • cloud:[5,2000]
说明 安全沙箱节点要求至少有一块不小于200 GiB的数据盘。
worker_instance_charge_type String PrePaid Worker节点付费类型,可选值为:
  • PrePaid:包年包月。
  • PostPaid:按量付费。
默认:按量付费。
worker_instance_types Array of String ecs.ebmg5s.24xlarge Worker节点实例类型。
注意 安全沙箱集群只支持神龙裸金属实例
worker_period Long 1 Worker节点包年包月时长,当worker_instance_charge_type取值为PrePaid时才生效且为必选值。取值范围:{1,2,3,6,12,24,36,48,60}。

默认值:1。

worker_period_unit String Month Wroker节点付费周期,当付费类型为PrePaid的时候需要指定周期。取值:Month,当前只支持以月为周期。
worker_system_disk_category String cloud_efficiency Worker节点系统盘类型,取值:
  • cloud_efficiency:高效云盘。
  • cloud_ssd:SSD云盘。

默认值:cloud_ssd

worker_system_disk_size Long 120

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

取值范围:[40,500]。

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

默认值:120

worker_vswitch_ids Array of String vsw-2ze3ds0mdip0hdz8i**** 集群节点使用的虚拟交换机列表,一个节点对应一个值。
zone_id String cn-beijing-b 集群所属地域的可用区ID。

响应体语法

HTTP/1.1 200
Content-Type:application/json
{
  "cluster_id" : "String",
  "request_id" : "String",
  "task_id" : "String"
}

响应参数

表 2. 响应Body参数
名称 类型 示例值 描述
cluster_id String cb95aa626a47740afbf6aa099b650**** 集群ID。
request_id String 687C5BAA-D103-4993-884B-C35E4314A1E1 请求ID。
task_id String T-5a54309c80282e39ea00002f 任务ID。

示例1 使用Flannel网络插件创建ACK标准托管版安全沙箱集群

请求示例

POST /clusters
公共请求头
{
  "name": "webService",
  "cluster_type": "ManagedKubernetes",
  "disable_rollback": true,
  "timeout_mins": 60,
  "kubernetes_version": "1.18.8-aliyun.1",
  "region_id": "cn-hangzhou",
  "snat_entry": true,
  "cloud_monitor_flags": true,
  "endpoint_public_access": false,
  "deletion_protection": false,
  "node_cidr_mask": "26",
  "proxy_mode": "ipvs",
  "tags": [],
  "timezone": "Asia/Shanghai",
  "addons": [{
    "name": "flannel"
  }, {
    "name": "sandboxed-container-controller"
  }, {
    "name": "csi-plugin"
  }, {
    "name": "csi-provisioner"
  }, {
    "name": "logtail-ds",
    "config": "{\"IngressDashboardEnabled\":\"true\"}"
  }, {
    "name": "ack-node-problem-detector",
    "config": "{\"sls_project_name\":\"\"}"
  }, {
    "name": "nginx-ingress-controller",
    "config": "{\"IngressSlbNetworkType\":\"internet\"}"
  }, {
    "name": "arms-prometheus"
  }],
  "runtime": {
    "name": "Sandboxed-Container.runv",
    "version": "2.1.0"
  },
  "worker_instance_types": ["ecs.ebmc5s.24xlarge"],
  "num_of_nodes": 3,
  "worker_system_disk_category": "cloud_essd",
  "worker_system_disk_size": 120,
  "worker_data_disks": [{
    "category": "cloud_efficiency",
    "size": "200",
    "encrypted": "false",
    "auto_snapshot_policy_id": ""
  }],
  "worker_instance_charge_type": "PostPaid",
  "vpcid": "vpc-bp1gxh70jnkl12vq27jg7",
  "container_cidr": "172.23.0.0/16",
  "service_cidr": "172.21.0.0/20",
  "vswitch_ids": ["vsw-bp1hl2o4i9z7sbmy*****"],
  "login_password": "Hello1234!",
  "logging_type": "SLS",
  "cpu_policy": "none",
  "is_enterprise_security_group": true
}

正常返回示例

XML格式
<cluster_id>cb95aa626a47740afbf6aa099b650****</cluster_id>
<task_id>T-5a54309c80282e39ea00002f</task_id>
<request_id>687C5BAA-D103-4993-884B-C35E4314A1E1</request_id>
JSON格式
{
    "cluster_id": "cb95aa626a47740afbf6aa099b650****",
    "task_id": "T-5a54309c80282e39ea00002f",
    "request_id": "687C5BAA-D103-4993-884B-C35E4314A1E1"
}

示例2 使用Terway网络插件创建ACK标准托管版安全沙箱集群

说明 如果您创建是Terway网络类型的集群,pod_vswitch_ids为必填参数。

请求示例

POST /clusters HTTP/1.1
公共请求头
{
  "name": "webService",
  "cluster_type": "ManagedKubernetes",
  "disable_rollback": true,
  "timeout_mins": 60,
  "kubernetes_version": "1.18.8-aliyun.1",
  "region_id": "cn-hangzhou",
  "snat_entry": true,
  "cloud_monitor_flags": true,
  "endpoint_public_access": false,
  "deletion_protection": false,
  "proxy_mode": "ipvs",
  "tags": [],
  "timezone": "Asia/Shanghai",
  "addons": [{
    "name": "terway-eniip",
    "config": "{\"IPVlan\":\"false\",\"NetworkPolicy\":\"false\"}"
  }, {
    "name": "sandboxed-container-controller"
  }, {
    "name": "csi-plugin"
  }, {
    "name": "csi-provisioner"
  }, {
    "name": "logtail-ds",
    "config": "{\"IngressDashboardEnabled\":\"true\"}"
  }, {
    "name": "ack-node-problem-detector",
    "config": "{\"sls_project_name\":\"\"}"
  }, {
    "name": "nginx-ingress-controller",
    "config": "{\"IngressSlbNetworkType\":\"internet\"}"
  }, {
    "name": "arms-prometheus"
  }],
  "pod_vswitch_ids": ["vsw-bp1e5819t8dl8ulcrpgkm"],
  "runtime": {
    "name": "Sandboxed-Container.runv",
    "version": "2.1.0"
  },
  "worker_instance_types": ["ecs.ebmc5s.24xlarge"],
  "num_of_nodes": 3,
  "worker_system_disk_category": "cloud_essd",
  "worker_system_disk_size": 120,
  "worker_data_disks": [{
    "category": "cloud_efficiency",
    "size": "200",
    "encrypted": "false",
    "auto_snapshot_policy_id": ""
  }],
  "worker_instance_charge_type": "PostPaid",
  "vpcid": "vpc-bp1gxh70jnkl12vq27jg7",
  "service_cidr": "172.21.0.0/20",
  "vswitch_ids": ["vsw-bp1hl2o4i9z7sbmy*****"],
  "login_password": "Hello1234!",
  "logging_type": "SLS",
  "cpu_policy": "none",
  "is_enterprise_security_group": true
}

正常返回示例

XML格式
<cluster_id>cb95aa626a47740afbf6aa099b650****</cluster_id>
<task_id>T-5a54309c80282e39ea00002f</task_id>
<request_id>687C5BAA-D103-4993-884B-C35E4314A1E1</request_id>
JSON格式
{
    "cluster_id": "cb95aa626a47740afbf6aa099b650****",
    "task_id": "T-5a54309c80282e39ea00002f",
    "request_id": "687C5BAA-D103-4993-884B-C35E4314A1E1"
}

错误码

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

开发者资源

  • SDK

    阿里云为您提供多种语言的SDK,帮助您快速通过API集成阿里云的产品和服务,推荐您使用SDK调用API,已免除您手动签名验证,详情请参见SDK参考文档链接。

  • OpenAPI Explorer

    快速检索,可视化调试API,在线命令行工具,同步动态生成可执行的SDK代码示例。

  • 阿里云CLI

    阿里云资产管理和配置工具,可通过命令方式同时管理多个阿里云产品和服务,简单快捷,是您上云好帮手。