创建一个新的Kubernetes边缘托管版集群实例。

请求信息

请求行RequestLine

POST /clusters HTTP/1.1 

特有请求头RequestHead

无,请参考公共请求头部

请求体RequestBody

{
"disable_rollback": "失败是否回滚。",
"name": "集群名称。",
"timeout_mins": "集群创建超时时间。",
"cluster_type": "集群类型,ManagedKubernetes。",
"profile":"边缘集群标志,Edge。",
"region_id": "地域",
"vpcid": "VPC ID",
"vswitch_ids": "一台或多台虚拟交换机ID,N的取值范围为[1, 5]。",
"container_cidr": "容器POD CIDR。",
"service_cidr": "服务CIDR",
"cloud_monitor_flags":"是否安装云监控插件。",
"login_password": "节点SSH登陆密码,和key_pair二选一。",
"key_pair":"keypair名称,和login_password二选一。",
"worker_instance_types": "Worker实例规格多实例规格参数。 ",
"worker_system_disk_category": "Worker系统盘类型。",
"worker_system_disk_size": "Worker节点系统盘大小。",
"worker_data_disk":"是否挂载数据盘true|false",
"worker_data_disk_category":"数据盘类型。",
"worker_data_disk_size":"数据盘大小",
"num_of_nodes": "Worker节点数",
"snat_entry": "是否配置SNATEntry。",
"endpoint_public_access": "是否公网暴露集群endpoint。",
"tags": "给集群打tag标签, 数组格式对象。"
}
表 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,300]。
profile string 边缘集群标识,默认取值为Edge。
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节点系统盘大小。
container_cidr string 容器网段,不能和VPC网段冲突。当选择系统自动创建VPC时,默认使用172.16.0.0/16网段。
cloud_monitor_flags bool 是否安装云监控插件。
说明 如果您选择了使用日志或者监控服务,会自动购买一个云端ECS节点用于部署相应管控服务,那么需要配置云端worker的登录信息和资源规格信息。
disable_rollback bool 失败是否回滚:
  • true:表示失败不回滚。
  • false:表示失败回滚。
如果选择失败回滚,则会释放创建过程中所生产的资源,不推荐使用false
proxy_mode string kube-proxy代理模式,支持iptables和IPVS两种模式。 默认为iptables。
endpoint_public_access bool 是否开启公网API Server:
  • true:默认为True,表示开放公网API Server。
  • false:若设置为false, 则不会创建公网的API Server,仅创建私网的API Server。
说明 在边缘集群场景,边缘节点通过公网和云端管控交互;因此,边缘集群需要开启公网访问。
service_cidr string 服务网段,不能和VPC网段以及容器网段冲突。当选择系统自动创建VPC时,默认使用172.19.0.0/20网段。
tags list 给集群打tag标签:
  • key:标签名称
  • value:标签值
timeout_mins int 集群资源栈创建超时时间,以分钟为单位,默认值60分钟。
vpcid string VPC ID,可空。如果不设置,系统会自动创建VPC,系统创建的VPC网段为192.168.0.0/16。VpcId和vswitchid只能同时为空或者同时都设置相应的值。
worker_data_disk string 是否挂载数据盘,可选择:
  • true:表示worker节点挂载数据盘。
  • false:表示worker节点不挂载数据盘。
worker_data_disk_category int 数据盘类型
worker_data_disk_size string 数据盘大小

返回信息

返回行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":"ManagedKubernetes",
"profile":"Edge",
"disable_rollback":true,
"timeout_mins":60,
"region_id":"cn-beijing",
"snat_entry":true,
"cloud_monitor_flags":true,
"endpoint_public_access":true,
"tags":[],
"worker_instance_types":["ecs.hfc5.xlarge"],
"num_of_nodes":1,
"worker_system_disk_category":"cloud_efficiency",
"vpcid":"vpc-2zegvl5eta******",
"container_cidr":"172.20.0.0/16",
"service_cidr":"172.21.0.0/20",
"vswitch_ids":["vsw-2ze48rkq464rsdts1****"],
"login_password":"test@19****"
}

返回示例

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