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

请求信息

请求行 RequestLine

POST /clusters HTTP/1.1

请求行参数 URI Param

特有请求头 RequestHead

无,请参考 公共请求头部

请求体 RequestBody

{
    "password": "ECS实例root登录密码",
    "region_id": "RegionID",
    "instance_type": "实例规格",
    "name": "集群名称",
    "size": "节点数",
    "network_mode": "vpc",
    "vpc_id": "VPC_ID",
    "vswitch_id": "交换机ID",
    "subnet_cidr": "容器网段,如172.28.1.0/24",
    "data_disk_category": "系统盘类型",
    "data_disk_size": "系统盘大小",
    "need_slb": "是否需要创建集群的负载均衡",
    "ecs_image_id": "操作系统镜像",
    "io_optimized": "是否IO优化",
    "release_eip_flag": "是否需要在集群配置完成后释放EIP"
    "rds_instances": "RDS 实例 ID"
}

请求体解释

名称 类型 必须 描述
name string 集群名称, 集群名称可以使用大小写英文字母、中文、数字、中划线。
size int 集群 ECS 节点数量。
instance_type string ECS 规格类型代码。更多详细信息,参见 实例规格族
network_mode string 集群网络模式(VPC 网络: vpc),目前仅支持 VPC 网络。
subnet_cidr string 集群可以使用的网络地址块,例如:192.168.24.0/22。只有网络模式为 vpc 的时候,才需要设置该字段。
vpc_id string

VPC 网络 ID。只有网络模式为 vpc 的时候,才需要设置该字段。更多详细信息,参见 VPC 网络介绍

vswitch_id string VPC 网络的交换机 ID。只有网络模式为 vpc 的时候,才需要设置该字段。
password string root 账号密码。
data_disk_category string

ECS 使用的磁盘类型。更多详细信息,参见 磁盘种类表

data_disk_size number 节点共享磁盘大小。
ecs_image_id string 可选 ECS 使用的系统镜像 ID。参见 查询镜像列表 API
io_optimized string 可选 根据 ECS 实例规则来确定。取值为 none 或者 optimized。由于目前仅支持 VPC 网络,建议传入 optimized
need_slb bool 可选 是否需要创建集群默认的简单路由 SLB,默认为 true
release_eip_flag bool 可选 配置完集群后是否释放 EIP,默认为 false
rds_instances array 选择是否将 ECS 实例的 IP 添加到 RDS 的白名单里。

ecs_image_id 列表

请参考文档 查看镜像列表 获取 ecs_image_id 列表。如果您需要自定义集群的 ECS 镜像的 ID,需要保证 ECS 镜像满足以下条件:

  • 操作系统:Ubuntu、CentOS。
  • Linux Kernel version ≥ 3.18,用于支持 overlayfs 以及 overlay network。
  • 镜像中删除 /etc/docker/key.json 文件。

返回信息

返回行 ResponseLine

HTTP/1.1 202 Accepted

特有返回头 ResponseHead

无,请参考 公共返回头部

返回体 ResponseBody

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

示例

请求示例

POST /clusters HTTP/1.1
<公共请求头>
{
    "password": "TestPwd124",
    "region_id": "cn-beijing",
    "instance_type": "ecs.n1.small",
    "name": "my-test-cluster",
    "size": 1,
    "network_mode": "vpc",
    "vpc_id":"vpc-xxxx",
    "vswitch_id":"vsw-xxxx",
    "subnet_cidr":"172.28.1.0/24",
    "data_disk_category": "cloud_ssd",
    "data_disk_size": 40,
    "need_slb":true,
    "ecs_image_id":"centos_7_04_64_20G_alibase_201701015",
    "io_optimized":"true",
    "release_eip_flag":false
}

返回示例

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