云容器引擎-创建集群订单
接口功能介绍
调用该接口创建Kubernetes集群。
接口约束
无
URI
POST /v1.1/ccse/clusters/createByPaas
路径参数
无
Query参数
无
请求参数
请求头header参数
无
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
reqType | 是 | String | 请求类型:天翼云 | 2 | |
resPoolId | 是 | String | 资源池id | bb9fdb42056f11eda1610242ac110002 | |
clusterBaseV2VO | 是 | String of Object | 集群基本信息 | clusterBaseVO | |
masterHost | 是 | String of Object | master节点基本信息 | masterHost | |
slaveHost | 是 | String of Object | worker节点基本信息 | slaveHost |
表 clusterBaseV2VO
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
subnetUuid | 是 | String | 子网id | sn-w9th5mxnj1bw4gtsobbru | |
networkPlugin | 是 | String | 网络插件 | calico | |
clusterDomain | 是 | String | 集群本地域名 | cluster.local | |
podSubNetUuid | 否 | Long | pod子网id | subnet-u6yetftkis | |
securityGroupUuid | 是 | String | 安全组id | sg-k2sfnatqk275wbcg849ig | |
startPort | 是 | Long | 节点服务开始端口 | 30000 | |
endPort | 是 | Long | 节点服务终止端口 | 32767 | |
enableEip | 否 | Boolean | 是否使用eip | false | |
floatingipId | 否 | Long | eipId,使用eip时必传 | 34462 | |
elbProdCode | 是 | String | elb类型 | standardI | |
nodeLabels | 否 | Map of String | 节点标签 | {"app": "label"} | |
podCidr | 是 | String | pod网络CIDR | 172.26.0.0/16 | |
installNginxIngress | 否 | Boolean | 是否安装nginx ingress插件 | false | |
billMode | 是 | String | 计费模式:1为包周期,2为按需 | 1 | |
cycleType | 否 | String | 订购周期类型:3表示按月订购,101表示按需订购 | 3 | |
cycleCnt | 否 | Integer | 订购时长:cycleType为3时,cycleCnt为1表示订购1个月;cycleType为101时不需要为此参数赋值 | 1 | |
antoRenewStatus | 否 | Boolean | 是否自动续费 | false | |
autoRenewCycleType | 否 | String | 自动续费周期 | 3 | |
containerRuntime | 是 | String | 容器运行时 | docker | |
timezone | 是 | String | 时区 | Asia/Shanghai (UTC+08:00) | |
clusterVersion | 是 | String | 集群版本 | 1.23.3 | |
deployType | 是 | String | 部署模式:单可用区为single,多可用区为multi。 | single | |
azInfo | 是 | String | 可用区 | [{"azId": 206,"azName": "az1"}] | |
serviceCidr | 否 | String | 服务CIDR | 172.26.0.0/16 | |
nodePool | 否 | String | 节点池 | default | |
vpcUuid | 是 | String | 用户vpcOid | vpc-6m2e36h64ibs06iyy43b6 | |
clusterName | 是 | String | 集群名字 | test-123 | |
kubeProxy | 是 | String | kubeProxy类型:iptables或ipvs | iptables | |
hostType | 是 | String | 主机系列 | S | |
mirrorCategoryName | 是 | String | 操作系统 | ctyunos2.0.1 | |
pluginCstorcsiAk | 否 | String | CSI插件AK | 8d7b21fregtegeb2dda072c81b80133 | |
pluginCstorcsiSk | 否 | String | CSI插件SK | 54786hfvjkdsbbfrtgbtgr2dda0234454 | |
pluginCstorcsiEnabled | 否 | Boolean | 是否启用csi插件 | false | |
pluginCcseMonitorEnabled | 否 | Boolean | 是否启用监控插件 | false | |
clusterSeries | 是 | String | 集群系列 | ccseagent.standard |
表 masterHost
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
cpu | 是 | Integer | cpu | 4 | |
mem | 是 | Integer | 内存 | 8 | |
itemDefId | 否 | Long | 实例规格id | 5 | |
itemDefName | 否 | String | 实例规格名称 | s6.xlarge.2 | |
itemDefType | 是 | String | 实例规格类型 | s6 | |
resType | 是 | String | 主机类型 | ecs | |
size | 是 | Integer | master节点数量 | 1 | |
sysEBSVo | 否 | String of Object | 系统盘信息 | sysEBSVo | |
dataEBSVo | 否 | Array of Objects | 数据盘信息 | dataEBSVo |
表 sysEBSVo
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
itemDefId | 否 | Long | 系统盘id | 3 | |
itemDefName | 否 | String | 系统盘名字 | ||
itemDefType | 否 | String | 系统盘类型 | ||
resType | 否 | String | 主机类型 | ebs | |
size | 否 | Integer | 系统盘大小,单位为G | 120 |
表 slaveHost
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
cpu | 是 | Integer | cpu | 4 | |
mem | 是 | Integer | 内存 | 8 | |
itemDefId | 否 | Long | 实例规格id | 5 | |
itemDefName | 否 | String | 实例规格名称 | s6.xlarge.2 | |
itemDefType | 是 | String | 实例规格类型 | s6 | |
size | 是 | Integer | worker节点数量 | 1 | |
sysEBSVo | 否 | String of Object | 系统盘信息 | sysEBSVo | |
dataEBSVo | 否 | Array of Objects | 数据盘信息 | dataEBSVo |
表 dataEBSVo
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
itemDefId | 否 | Long | 数据盘id | 3 | |
itemDefName | 否 | String | 数据盘名字 | 1 | |
itemDefType | 否 | String | 数据盘类型 | ||
resType | 否 | String | 主机类型 | ebs | |
size | 否 | Integer | 数据盘大小,单位为G | 120 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | String | 状态码 | 800 | |
message | String | 提示信息 | ||
error | String | 错误码 | CCSE_500 | |
returnObj | Object | 返回对象 | returnObj |
表 returnObj
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
orderId | String | 订单id | 8355b4ed6f04b1eb98f4ec1f4cd45b0 | |
orderNo | String | 订单编号 | 202308022237226225837 |
枚举参数
无
请求示例
请求url
POST https://ccse-global.ctapi.ctyun.cn/v1.1/ccse/clusters/createByPaas
请求头header
{regionId:bb9fdb42056f11eda1610242ac110002}
请求体body
{
"clusterBaseV2VO":{
"azInfo":" [{\"azId\": 34,\"azName\": \"cn-sh36-sh1A-public-ctcloud\"}]",
"billMode":"1",
"clusterDomain":"cluster.local",
"clusterName":"ccse-testsyy1103",
"clusterSeries":"ccseagent.standard",
"clusterVersion":"1.23.3",
"containerRuntime":"docker",
"cycleCnt":1,
"cycleType":"3",
"deployType":"single",
"elbProdCode":"standardI",
"enableEip":false,
"endPort":32767,
"hostType":"S",
"installNginxIngress":false,
"kubeProxy":"iptables",
"mirrorCategoryName":"ctyunos2.0.1",
"networkPlugin":"cubecni",
"nodeLabels":{
"age":"1"
},
"podCidr":"192.168.0.0/16",
"podSubNetUuid":"subnet-n0tj44p4tz",
"securityGroupUuid":"sg-mjbd02z08a",
"startPort":30000,
"subnetUuid":"subnet-slr3796q3y",
"timezone":"Asia/Shanghai (UTC+08:00)",
"vpcUuid":"vpc-dlkyav486x"
},
"masterHost":{
"cpu":4,
"dataEBSVo":[
{
"itemDefType":"s6",
"resType":"SSD",
"size":100
}
],
"itemDefType":"s6",
"mem":8,
"resType":"SSD",
"size":1,
"sysEBSVo":{
"itemDefType":"s6",
"resType":"SSD",
"size":120
}
},
"reqType":"2",
"resPoolId":"200000001790",
"slaveHost":{
"cpu":4,
"dataEBSVo":[
{
"itemDefType":"ecs",
"resType":"SSD",
"size":100
}
],
"itemDefType":"s6",
"mem":8,
"size":1,
"sysEBSVo":{
"itemDefType":"s6",
"resType":"SSD",
"size":120
}
}
}
响应示例
{
"statusCode": 800,
"message": "创建集群成功:test",
"returnObj": true
}