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

请求信息

请求行 RequestLine

POST /clusters HTTP/1.1

特有请求头 RequestHead

无,请参考公共请求头部

请求体 RequestBody

{
    "disable_rollback": "失败是否回滚",
    "name": "集群名称",
    "timeout_mins": 集群创建超时时间,
    "cluster_type": "集群类型,Kubernetes",
    "region_id": "地域",
    "vpcid": "VPC ID",
    "zoneid": "可用区",
    "vswitchid": "交换机ID",    
    "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_type": "Master实例规格",
    "master_system_disk_category": "Master系统盘类型",
    "master_system_disk_size":"Master节点系统盘大小",
    "worker_instance_type": "Worker实例规格",
    "worker_system_disk_category": "Worker系统盘类型",
    "worker_system_disk_size": "Worker节点系统盘大小",
    "num_of_nodes": "Worker节点数",
    "snat_entry": 是否配置SNATEntry,
}

请求体解释

名称 类型 必须 描述
disable_rollback bool 失败是否回滚,true表示失败不回滚,false失败回滚。如果选择失败回滚,则会释放创建过程中所生产的资源,不推荐使用false
name string 集群名称,集群名称可以使用大小写英文字母、中文、数字、中划线
timeout_mins int 集群资源栈创建超时时间,以分钟为单位,默认值 60
region_id string 集群所在地域ID
zoneid string 所属地域的可用区
vpcid string VPCID,可空。如果不设置,系统会自动创建VPC,系统创建的VPC网段为192.168.0.0/16。 VpcIdvswitchid 只能同时为空或者同时都设置相应的值
vswitchid string 交换机ID,可空。若不设置,系统会自动创建交换机,系统自定创建的交换机网段为 192.168.0.0/16
container_cidr string 容器网段,不能和VPC网段冲突。当选择系统自动创建VPC时,默认使用172.16.0.0/16网段
service_cidr string 服务网段,不能和VPC网段以及容器网段冲突。当选择系统自动创建VPC时,默认使用172.19.0.0/20网段
master_instance_type string Master节点 ECS 规格类型代码。更多详细信息,参见 实例规格族
master_system_disk_category string Master节点系统盘类型
master_system_disk_size int Master节点系统盘大小
worker_instance_type string Worker 节点 ECS 规格类型代码。更多详细信息,参见 实例规格族
worker_system_disk_category string Worker节点系统盘类型
worker_system_disk_size int Worker节点系统盘大小
login_password string SSH登录密码。密码规则为 8 - 30 个字符,且同时包含三项(大、小写字母,数字和特殊符号)。和 key_pair 二选一
key_pair string keypair名称。与 login_password二选一
num_of_nodes int Worker节点数。范围是[0,300]
snat_entry bool 是否为网络配置SNAT。如果是自动创建VPC必须设置为 true。如果是使用已有VPC,则根据是否具备出网能力来设置
ssh_flags bool 是否开放公网SSH登录
cloud_monitor_flags bool 是否安装云监控插件

返回信息

返回行 ResponseLine

HTTP/1.1 202 Accepted

特有返回头 ResponseHead

无,请参考 公共返回头部

返回体 ResponseBody

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

示例

请求示例

POST /clusters HTTP/1.1
<公共请求头>
{
    "disable_rollback": true,
    "name": "my-test-Kubernetes-cluster",
    "timeout_mins": 60,
    "cluster_type": "Kubernetes",
    "region_id": "cn-beijing",
    "zoneid": "cn-beijing-f",
    "vpcid": "",
    "vswitchid": "",
    "num_of_nodes": 1,
    "container_cidr": "172.16.0.0/16",
    "service_cidr": "172.19.0.0/20",
    "cloud_monitor_flags": true,
    "master_instance_type": "ecs.sn1ne.large",
    "master_system_disk_category": "cloud_efficiency",
    "master_system_disk_size": 40,
    "worker_instance_type": "ecs.sn1ne.large",
    "worker_system_disk_category": "cloud_efficiency",
    "worker_system_disk_size": 40,
    "snat_entry": true,
    "ssh_flags": true,
    "login_password": "Hello1234"
}

返回示例

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