创建集群
更新时间:2026-09-24
接口描述
创建一个用户指定配置的集群。
注意:
用户创建集群前,需要开通CHPC服务。
请求
请求结构
Bash
1POST /v{version}/cluster HTTP/1.1
2Host: chpc.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "clusterType": "{clusterType}",
7 "clusterName": "{clusterName}",
8 "description": "{description}",
9 "zoneName": "{zoneName}",
10 "vpcId": "{vpcId}",
11 "securityGroupType": "{securityGroupType}",
12 "securityGroupId": "{securityGroupId}",
13 "schedulerType": "{schedulerType}",
14 "schedulePlugin": {schedulePlugin},
15 "schedulePluginVersion": "{schedulePluginVersion}",
16 "schedulerVersion": "{schedulerVersion}",
17 "forbidDelete": {forbidDelete},
18 "masterSpec": {
19 "subnetId": "{masterSubnetId}",
20 "chargeType": "{chargeType}",
21 "spec": "{masterSpec}",
22 "count": {masterCount},
23 "imageId": "{masterImageId}",
24 "systemDisk": {
25 "storageType": "{systemDiskType}",
26 "size": {systemDiskSize},
27 "cdsNum": {cdsNum}
28 },
29 "dataDiskList": []
30 },
31 "queueList": [
32 {
33 "queueName": "{queueName}",
34 "isDefault": {isDefault},
35 "subnetId": "{queueSubnetId}",
36 "nodeCount": {nodeCount},
37 "computeSpec": {
38 "subnetId": "{computeSubnetId}",
39 "chargeType": "{chargeType}",
40 "spec": "{computeSpec}",
41 "count": {computeCount},
42 "imageId": "{computeImageId}",
43 "systemDisk": {
44 "storageType": "{systemDiskType}",
45 "size": {systemDiskSize}
46, "cdsNum": {cdsNum}
47 },
48 "dataDiskList": []
49 }
50 }
51 ],
52 "mountList": [
53 {
54 "cfsId": "{cfsId}",
55 "mountPoint": "{mountPoint}",
56 "mountDirectory": "{mountDirectory}",
57 "mountOption": "{mountOption}"
58 }
59 ],
60 "softwareList": []
61}
请求头域
除公共头域外,无其他特殊头域。
请求参数
| 参数名称 | 类型 | 是否必须 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | Integer | 是 | Path 参数 | API 版本号。例如 1,如 /v1/cluster。 |
| clientToken | String | 否 | Query 参数 | 幂等性 Token,是一个长度不超过 64 位的 ASCII 字符串。 |
| clusterType | String | 否 | Body 参数 | 集群类型。当前线上接口请求示例使用 cloud。 |
| clusterName | String | 是 | Body 参数 | 集群名称,长度为 2~15 个字符。集群名称只能包含英文大小写字母、数字和 _。必须以英文字母开头,以英文或数字结尾。 |
| description | String | 否 | Body 参数 | 集群描述。 |
| zoneName | String | 是 | Body 参数 | 可用区名称,例如 cn-bj-d。 |
| vpcId | String | 是 | Body 参数 | 新创建集群所属的 VPC ID。 |
| securityGroupType | String | 否 | Body 参数 | 安全组类型。当前线上接口请求示例使用 normal。 |
| securityGroupId | String | 是 | Body 参数 | 指定新创建集群所属的安全组 ID,安全组需要开通所有端口。 |
| schedulerType | String | 否 | Body 参数 | 调度器类型。当前线上支持 slurm。 |
| schedulePlugin | Integer | 否 | Body 参数 | 调度插件配置值。当前线上请求示例使用 1。 |
| schedulePluginVersion | String | 否 | Body 参数 | 调度插件版本。当前线上请求示例使用 0.1.0。 |
| schedulerVersion | String | 否 | Body 参数 | 调度器版本。当前线上请求示例使用 22.05.9。 |
| forbidDelete | Boolean | 否 | Body 参数 | 是否禁止删除集群。 |
| masterSpec | Object | 是 | Body 参数 | 管控节点配置对象。 |
| masterSpec.subnetId | String | 是 | Body 参数 | 管控节点所在子网 ID。 |
| masterSpec.chargeType | String | 否 | Body 参数 | 管控节点付费类型。取值范围:Postpaid:按量付费;Prepaid:包年包月。默认 Postpaid。 |
| masterSpec.spec | String | 是 | Body 参数 | 管控节点规格,例如 bcc.g5.c2m8。 |
| masterSpec.count | Integer | 否 | Body 参数 | 管控节点数量。当前线上请求示例使用 1。 |
| masterSpec.imageId | String | 是 | Body 参数 | 管控节点镜像 ID。 |
| masterSpec.systemDisk | Object | 否 | Body 参数 | 管控节点系统盘配置对象。 |
| masterSpec.systemDisk.storageType | String | 否 | Body 参数 | 系统盘类型,可选类型参考 StorageType。 |
| masterSpec.systemDisk.size | Integer | 否 | Body 参数 | 系统盘大小,单位 GB。 |
| masterSpec.systemDisk.cdsNum | Integer | 否 | Body 参数 | 系统盘 cdsNum 配置值。 |
| masterSpec.dataDiskList | Array | 否 | Body 参数 | 管控节点数据盘列表。传空数组表示不创建数据盘;如需创建数据盘,存储类型可选类型参考 StorageType。 |
| queueList | Array | 是 | Body 参数 | 队列配置列表,至少包含 1 个队列对象。 |
| queueList[].queueName | String | 是 | Body 参数 | 队列名称。 |
| queueList[].isDefault | Boolean | 否 | Body 参数 | 是否为默认队列。 |
| queueList[].subnetId | String | 是 | Body 参数 | 队列所在子网 ID。 |
| queueList[].nodeCount | Integer | 是 | Body 参数 | 队列节点数量。当前线上请求示例使用 1。 |
| queueList[].computeSpec | Object | 是 | Body 参数 | 计算节点配置对象。 |
| queueList[].computeSpec.subnetId | String | 是 | Body 参数 | 计算节点所在子网 ID。 |
| queueList[].computeSpec.chargeType | String | 否 | Body 参数 | 计算节点付费类型。取值范围:Postpaid:按量付费;Prepaid:包年包月。默认 Postpaid。 |
| queueList[].computeSpec.spec | String | 是 | Body 参数 | 计算节点规格,例如 bcc.g5.c2m8。 |
| queueList[].computeSpec.count | Integer | 否 | Body 参数 | 计算节点数量。当前线上请求示例使用 1。 |
| queueList[].computeSpec.imageId | String | 否 | Body 参数 | 计算节点镜像 ID。 |
| queueList[].computeSpec.systemDisk | Object | 否 | Body 参数 | 计算节点系统盘配置对象。 |
| queueList[].computeSpec.systemDisk.storageType | String | 否 | Body 参数 | 系统盘类型,可选类型参考 StorageType。 |
| queueList[].computeSpec.systemDisk.size | Integer | 否 | Body 参数 | 系统盘大小,单位 GB。 |
| queueList[].computeSpec.systemDisk.cdsNum | Integer | 否 | Body 参数 | 系统盘 cdsNum 配置值。 |
| queueList[].computeSpec.dataDiskList | Array | 否 | Body 参数 | 计算节点数据盘列表。传空数组表示不创建数据盘;如需创建数据盘,存储类型可选类型参考 StorageType。 |
| mountList | Array | 是 | Body 参数 | 挂载配置列表。当前线上接口要求至少包含 1 个挂载配置。 |
| mountList[].cfsId | String | 否 | Body 参数 | CFS 文件系统 ID。使用 CFS 挂载形态时填写。 |
| mountList[].mountPoint | String | 是 | Body 参数 | 挂载点。使用本地挂载时填写 IP:/path;使用 CFS 挂载时填写可访问的挂载点地址。 |
| mountList[].mountDirectory | String | 是 | Body 参数 | 挂载共享存储的目录,例如 /home。 |
| mountList[].mountOption | String | 否 | Body 参数 | 挂载参数。当前线上接口会校验该字段的合法性。 |
| softwareList | Array | 否 | Body 参数 | 软件配置列表。当前线上请求示例传空数组。 |
响应
响应头域
除公共头域外,无其他特殊头域。
响应参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| requestId | String | 请求 ID。 |
| message | String | 请求结果描述信息。 |
| clusterId | String | 集群 ID。 |
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| BadRequest | masterSpec is empty. | 400 | 管控节点配置不能为空。 |
| BadRequest | The mountList size is invalid. Must be no less than 1. | 400 | mountList 至少需要包含 1 个挂载配置。 |
| BadRequest | The mount option is invalid. {} | 400 | mountOption 非法。 |
示例
请求示例
Bash
1POST /v1/cluster?clientToken=b9fd5bb531c049a596e0a72988631545 HTTP/1.1
2Host: chpc.bj.baidubce.com
3Authorization: bce-auth-v1/ALTAKfdDegfDEgedgyhted54dg/2023-08-22T09:48:15Z/1800/host/2fab6012ac3ba584ba990d5773bb56e5ce8e7f466398220c2842d33d02c6818a
4
5{
6 "clusterType": "cloud",
7 "clusterName": "testflowlocal2",
8 "zoneName": "cn-bj-d",
9 "vpcId": "vpc-3fy0ka0fzi9p",
10 "securityGroupType": "normal",
11 "securityGroupId": "g-0ndjfeqra9yn",
12 "schedulerType": "slurm",
13 "schedulePlugin": 1,
14 "schedulePluginVersion": "0.1.0",
15 "schedulerVersion": "22.05.9",
16 "forbidDelete": false,
17 "masterSpec": {
18 "subnetId": "sbn-05j83ivwuyz9",
19 "chargeType": "Postpaid",
20 "spec": "bcc.g5.c2m8",
21 "count": 1,
22 "imageId": "m-Wv6r9G3p",
23 "systemDisk": {
24 "storageType": "premium_ssd",
25 "size": 40,
26 "cdsNum": 1
27 },
28 "dataDiskList": []
29 },
30 "queueList": [
31 {
32 "queueName": "defaultQueue",
33 "isDefault": true,
34 "subnetId": "sbn-05j83ivwuyz9",
35 "nodeCount": 1,
36 "computeSpec": {
37 "subnetId": "sbn-05j83ivwuyz9",
38 "chargeType": "Postpaid",
39 "spec": "bcc.g5.c2m8",
40 "count": 1,
41 "imageId": "m-Wv6r9G3p",
42 "systemDisk": {
43 "storageType": "premium_ssd",
44 "size": 40,
45 "cdsNum": 1
46 },
47 "dataDiskList": []
48 }
49 }
50 ],
51 "mountList": [
52 {
53 "mountPoint": "10.0.0.10:/data",
54 "mountDirectory": "/home"
55 }
56 ],
57 "softwareList": []
58}
响应示例
JSON
1{
2 "requestId": "317181bd-7f47-402e-93c4-9cf25df74c2e",
3 "message": "成功创建testflowlocal2集群(ID: c-58MEE426),地域:cn-bj-d,slurm公有云集群",
4 "clusterId": "c-58MEE426"
5}
评价此篇文章
