全部文档
当前文档

暂无内容

如果没有找到您期望的内容,请尝试其他搜索词

文档中心

创建集群

接口说明

该接口适用于用户创建容器集群

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数
参数名称
类型
必填
描述
Action String
公共参数,本接口取值:CreateCluster。
Version String
公共参数,本接口取值:2023-01-01。
ClusterName String

集群名称
有效值:2-64个字符,支持中文,英文,数字,以及特殊字符-_

示例值:test
ClusterDesc String

集群描述,255个字符以内。

示例值:test cluster
ClusterManageMode String

集群部署方式
INDEPENDENT_CLUSTER:独立部署集群MANAGED_CLUSTER: 托管集群

示例值:INDEPENDENT_CLUSTER
默认值:INDEPENDENT_CLUSTER
ProjectId String

所属项目ID

示例值:0
默认值:0
KubernetesVersion String

K8S版本:v1.26.11,v1.28.7,v1.30.6

示例值:v1.26.11
Network Object

集群网络信息

VpcId String

VPC ID

ApiServer Object

apiserver 信息

EipId String

EIP ID

PublicApiServerEnable Boolean

是否开启公网访问,默认值:false

示例值:false
默认值:false
ReserveSubnetId String

所选vpc的所在的终端子网Id

NetworkPluginVeType String

集群网络插件类型
• calico

示例值:calico
VpcCNI Object

VPC-CNI 信息

Enable Boolean

是否开启vpc-cni,默认值:false

示例值:false
默认值:false
DaemonMode String

开启vpc-cni必填
网络模式:
• eniOnly 独占网卡
• eniMultiIP 共享网卡

SubnetIds String[]

开启vpc-cni后必填,
vpc的子网id,必须选跟集群同vpc下的子网Id,可以填多个

SecurityGroup String

开启vpc-cni后必填,
弹性网卡安全组id,需要跟集群同vpc下的安全组id

PodCidr String

Pod CIDR 信息,如:10.0.0.0/16
• 不能与Service网段冲突
• 不能与VPC网段冲突
• 托管集群不支持33网段

ServiceCidr String

Service CIDR,如10.254.0.0/16
• 不能与Pod网段冲突
• 不能与Vpc网段冲突

MaxPodPerNode Int

Pod数量上限/节点
默认值:128
可选值:16,32,64,128,256

SANs String[]

集群证书SAN 信息

NodeInstanceSet Object[]

节点相关配置

BasicSetting Object

节点基础配置

Num Int

节点数量

NodeNameMode String

节点命名方式(集群默认)
INTERNAL_IP:主机IP
HOST_NAME:主机hostname

示例值:INTERNAL_IP
ImageId String

系统镜像ID

SecurityGroupId String

安全组ID

SubnetId String

子网ID

InstanceType String

机型

示例值:N3.4B
SystemDisk Object

系统盘配置

Type String

系统磁盘类型

示例值:SSD3.0
Size Int

系统磁盘大小

FileSystem String

epc系统盘类型 (默认值EXT4)
• EXT4
• XFS

示例值:EXT4
默认值:EXT4
Container Object

Container 配置

Runtime String

容器运行时

示例值:Containerd
Path String

容器日志文件存放路径

示例值:/data/container
LogMaxSize Int

容器日志文件最大存储

示例值:128
LogMaxFiles Int

容器日志文件最大数量

示例值:128
InstanceName String

实例名称

示例值:master
InstanceNameSuffix Int

实例名称后缀

示例值:1
AvailabilityZone String

可用区

示例值:cn-beijing-6a
DataDisk Object

数据盘配置

Type String

数据盘类型

示例值:SSD3.0
Size Int

数据盘大小(单位:GB)

示例值:30
DeleteWithInstance Boolean

是否随实例删除

示例值:true
AutoFormatAndMount Boolean

是否自动挂载

示例值:true
FileSystem String

epc数据盘类型
• EXT4
• XFS

MountTarget String

epc数据盘目录
• /DATA/disk 在系统的DATA目录下,系统里展示内容如/DATA/disk1,/DATA/disk2
• /data 在系统的根目录下,系统里展示内容从/data1开始,如/data1,/data2
• /ssd

Suffix String

数据盘目录后缀属性
• NoSuffix 不使用后缀
• NaturalNumber:后缀从1底层的整数
• NaturalNumberFromZero:后缀从0递增的整数

LoginSetting Object

登录方式配置

Password String

密码

SSHKeyId String

实例登录秘钥Id信息 跟密码二选一

IsNew Boolean

是否为新建节点
true为新建节点
false为已有节点

SecurityGroupID String

安全组Id,为集群所选vpc下的安全组id(如果为空,则会创建一个新的安全组id)
如果为已有云主机实例,该字段为空时,会判断是否已有5个安全组,如果已有5个安全组会报错(云主机实例安全组上限为5个)

ChargeType String

计费方式(新建实例为必填项)
• monthly 包年包月
• dailysettlement 按量付费(按日月结)
• hourlyInstantSettlement(按小时结)

Unit String

购买时长单位,当计费方式为包年包月时必填
• 2 单位月

PurchaseTime String

购买时长,当计费方式为包年包月时必填,单位为月
有效值1-36
其他计费类型可不填,若填只能为0

Raid String

epc专有字段
数据盘Raid级别,和数据盘的数量直接相关(新建节点必填)
有效值: Raid1,Raid5,Raid10,Raid50,SRaid0

NetworkInterfaceMode String

epc专有字段:
网卡模式(新建节点必填)
有效值:
bond4:BOND模式
single:非BOND模式
dual:双网卡模式
windows创建时,只支持非bond模式。

BondName String

epc专有字段
bond名称
有效值:
• bond0(默认值)
• bond1

GpuImageDriverId String

epc专有字段
gpu的驱动id (为gpu类型才生效)
命名方式为cuda版本+“_” + GPU驱动,示例:12.0_525.105.17
可参考裸金属文档:https://apiexplorer.ksyun.com/#/api/44/DescribeGpuImageDriver/2015-11-01/1003

AdvancedSetting Object

节点高级配置

PostUserScript String

部署前执行脚本(base64 加密后的密文)

PreUserScript String

部署后执行脚本(base64 加密后的密文)

Labels Object[]

Label 列表

Key String

Label Key

Value String

Label Value

Taints Object[]
Key String

Taints key

Value String

Taints Value

Effect String

Taint Effect
(包括:NoSchedule、NoExecute、PreferNoSchedule)

Container Object

容器相关信息

Runtime String

容器运行时名称:
• Containerd(默认)

示例值:Containerd
默认值:Containerd
Path String

容器存储目录,默认值为:/data/container

示例值:/data/container
默认值:/data/container
Components Object[]

组件配置

Type String

组件类型

Args String

组件参数配置

LogMaxSize Int

容器单个日志文件大小 单位:Mi,默认值为100

示例值:100
默认值:100
LogMaxFiles Int

日志文件数量大小,默认值为10

示例值:10
默认值:10
Provider String

实例类型
• KEC 云服务器
• EPC 裸金属服务器

示例值:KEC
Addons Object[]

addon插件配置

Name String

插件名称(会根据插件名称选择
• csi-driver
• lb-controller (推荐默认选择该组件)
• kube-proxy (推荐默认选择该组件,确实该组件会影响集群网络功能)
• nvidia-gpu (gpu机型才能选择)

示例值:calico

返回参数

参数名称
类型
描述
RequestId String

请求ID

示例值:5551220b-d9ac-4d57-a83d-6c539a43079a
Data Object

返回数据

ClusterId String

集群ID

示例值:0b27dd72-5b81-4cf5-8819-66d6e90444dd

请求示例

curl -X POST
'http://kce2.api.ksyun.com/?Action=CreateCluster&Version=2023-01-01'
-H 'authorization: xxx, SignedHeaders=content-type;host;x-amz-date, Signature=xxx'
-H 'cache-control: no-cache'
-H 'content-type: application/json'
-H 'host: kce2.api.ksyun.com'
-H 'x-amz-date: 20170720T022802Z'
-d '{"ClusterName":"xxx","ClusterDesc":"xxx","ClusterManageMode":"INDEPENDENT_CLUSTER","ProjectId":"0","KubernetesVersion":"xxx","Network":{"VpcId":"xxx","ApiServer":{"EipId":"xxx","PublicApiServerEnable":"false","ReserveSubnetId":"xxx"},"NetworkPluginVeType":"xxx","VpcCNI":{"Enable":"false","DaemonMode":"xxx","SubnetIds":["xxx"],"SecurityGroup":"xxx"},"PodCidr":"xxx","ServiceCidr":"xxx","MaxPodPerNode":"xxx","SANs":["xxx"]},"NodeInstanceSet":[{"BasicSetting":{"Num":"xxx","NodeNameMode":"xxx","ImageId":"xxx","SecurityGroupId":"xxx","SubnetId":"xxx","InstanceType":"xxx","SystemDisk":{"Type":"xxx","Size":"xxx","FileSystem":"EXT4"},"Container":{"Runtime":"xxx","Path":"xxx","LogMaxSize":"xxx","LogMaxFiles":"xxx"},"InstanceName":"xxx","InstanceNameSuffix":"xxx","AvailabilityZone":"xxx","DataDisk":{"Type":"xxx","Size":"xxx","DeleteWithInstance":"xxx","AutoFormatAndMount":"xxx","FileSystem":"xxx","MountTarget":"xxx","Suffix":"xxx"},"LoginSetting":{"Password":"xxx","SSHKeyId":"xxx"},"IsNew":"xxx","SecurityGroupID":"xxx","ChargeType":"xxx","Unit":"xxx","PurchaseTime":"xxx","Raid":"xxx","NetworkInterfaceMode":"xxx","BondName":"xxx","GpuImageDriverId":"xxx"}},{"AdvancedSetting":{"PostUserScript":"xxx","PreUserScript":"xxx","Labels":[{"Key":"xxx"},{"Value":"xxx"}],"Taints":[{"Key":"xxx"},{"Value":"xxx"},{"Effect":"xxx"}],"Container":{"Runtime":"Containerd","Path":"/data/container"}}},{"Components":[{"Type":"xxx"},{"Args":"xxx"},{"LogMaxSize":"100"},{"LogMaxFiles":"10"}]},{"Provider":"xxx"}],"Addons":[{"Name":"xxx"}]}'

返回示例

JSON格式

{
"RequestId":"5551220b-d9ac-4d57-a83d-6c539a43079a",
"Data":{
"ClusterId":"0b27dd72-5b81-4cf5-8819-66d6e90444dd"
}
}

错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

纯净模式常规模式

纯净模式

点击可全屏预览文档内容