用户指南

创建集群

最近更新时间:2020-08-06 08:19:09

1. 接口描述

接口请求域名: tke.tencentcloudapi.com 。

创建集群

默认接口请求频率限制:20次/秒。

注意:本接口支持金融区地域。由于金融区和非金融区是隔离不互通的,因此当公共参数 Region 为金融区地域(例如 ap-shanghai-fsi)时,需要同时指定带金融区地域的域名,最好和 Region 的地域保持一致,例如:tke.ap-shanghai-fsi.tencentcloudapi.com。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateCluster。
Version String 公共参数,本接口取值:2018-05-25。
Region String 公共参数,详见产品支持的 地域列表
ClusterCIDRSettings ClusterCIDRSettings 集群容器网络配置信息
ClusterType String 集群类型,托管集群:MANAGED_CLUSTER,独立集群:INDEPENDENT_CLUSTER。
RunInstancesForNode.N Array of RunInstancesForNode CVM创建透传参数,json化字符串格式,详见CVM创建实例接口。总机型(包括地域)数量不超过10个,相同机型(地域)购买多台机器可以通过设置参数中RunInstances中InstanceCount来实现。
ClusterBasicSettings ClusterBasicSettings 集群的基本配置信息
ClusterAdvancedSettings ClusterAdvancedSettings 集群高级配置信息
InstanceAdvancedSettings InstanceAdvancedSettings 节点高级配置信息
ExistedInstancesForNode.N Array of ExistedInstancesForNode 已存在实例的配置信息。所有实例必须在同一个VPC中,最大数量不超过100。
InstanceDataDiskMountSettings.N Array of InstanceDataDiskMountSetting CVM类型和其对应的数据盘挂载配置信息

3. 输出参数

参数名称 类型 描述
ClusterId String 集群ID
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建托管集群示例

创建托管集群

输入示例

https://tke.tencentcloudapi.com/?Action=CreateCluster
&ClusterType=MANAGED_CLUSTER
&ClusterCIDRSettings.ClusterCIDR=10.4.0.0/14
&RunInstancesForNode.0.NodeRole=WORKER
&RunInstancesForNode.0.RunInstancesPara.0={"VirtualPrivateCloud":{"SubnetId":"subnet-xxx","VpcId":"vpc-xxx"},"Placement":{"Zone":"ap-region-1","ProjectId":1032509},"InstanceType":"S3.LARGE8","SystemDisk":{"DiskType":"CLOUD_PREMIUM"},"DataDisks":[{"DiskType":"CLOUD_PREMIUM","DiskSize":50}],"InstanceCount":1,"InternetAccessible":{"PublicIpAssigned":true,"InternetMaxBandwidthOut":1},"LoginSettings":{"Password":"YourPassword"},"UserData":"IyEvYmluL3NoCgplY2hvIGFhYQo="}
&ExtensionAddons.0.AddonName=GameApp
&ExtensionAddons.0.AddonReq={"kind":"GameApp","apiVersion":"platform.tke/v1","metadata":{"generateName":"ga"},"spec":{"clusterName":"xxx"}}
&<公共请求参数>

输出示例

{
  "Response": {
    "ClusterId": "cls-xxx",
    "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
  }
}

示例2 创建独立集群示例

创建独立集群

输入示例

https://tke.tencentcloudapi.com/?Action=CreateCluster
&ClusterType=INDEPENDENT_CLUSTER
&ClusterCIDRSettings.ClusterCIDR=10.4.0.0/14
&RunInstancesForNode.0.NodeRole=MASTER_ETCD
&RunInstancesForNode.0.RunInstancesPara.0={"VirtualPrivateCloud":{"SubnetId":"subnet-xxx","VpcId":"vpc-xxx"},"Placement":{"Zone":"ap-region-1","ProjectId":1032509},"InstanceType":"S3.LARGE8","SystemDisk":{"DiskType":"CLOUD_PREMIUM"},"DataDisks":[{"DiskType":"CLOUD_PREMIUM","DiskSize":50}],"InstanceCount":3,"InternetAccessible":{"PublicIpAssigned":true,"InternetMaxBandwidthOut":1},"LoginSettings":{"Password":"YourPassword"},"UserData":"IyEvYmluL3NoCgplY2hvIGFhYQo="}
&RunInstancesForNode.1.NodeRole=WORKER
&RunInstancesForNode.1.RunInstancesPara.0={"VirtualPrivateCloud":{"SubnetId":"subnet-xxx","VpcId":"vpc-xxx"},"Placement":{"Zone":"ap-region-1","ProjectId":1032509},"InstanceType":"S3.LARGE8","SystemDisk":{"DiskType":"CLOUD_PREMIUM"},"DataDisks":[{"DiskType":"CLOUD_PREMIUM","DiskSize":50}],"InstanceCount":1,"InternetAccessible":{"PublicIpAssigned":true,"InternetMaxBandwidthOut":1},"LoginSettings":{"Password":"YourPassword"},"UserData":"IyEvYmluL3NoCgplY2hvIGFhYQo="}
&ExtensionAddons.0.AddonName=GameApp
&ExtensionAddons.0.AddonReq={"kind":"GameApp","apiVersion":"platform.tke/v1","metadata":{"generateName":"ga"},"spec":{"clusterName":"xxx"}}
&<公共请求参数>

输出示例

{
  "Response": {
    "ClusterId": "cls-xxx",
    "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误
InternalError.AccountUserNotAuthenticated 账户未通过认证。
InternalError.AsCommon 伸缩组资源创建报错。
InternalError.CidrConflictWithOtherCluster CIDR和其他集群CIDR冲突。
InternalError.CidrConflictWithOtherRoute CIDR和其他路由冲突。
InternalError.CidrConflictWithVpcCidr CIDR和vpc冲突。
InternalError.CidrConflictWithVpcGlobalRoute CIDR和全局路由冲突。
InternalError.CidrInvali CIDR无效。
InternalError.CidrMaskSizeOutOfRange CIDR掩码无效。
InternalError.CreateMasterFailed 创建集群失败。
InternalError.CvmCommon cvm创建节点报错。
InternalError.Db db错误。
InternalError.DbAffectivedRows DB错误
InternalError.DbRecordNotFound 记录未找到。
InternalError.DfwGetUSGCount 获得当前安全组总数失败。
InternalError.DfwGetUSGQuota 获得安全组配额失败。
InternalError.InitMasterFailed 初始化master失败。
InternalError.InvalidPrivateNetworkCidr 无效CIDR。
InternalError.OsNotSupport 镜像OS不支持。
InternalError.Param Param。
InternalError.PublicClusterOpNotSupport 集群不支持当前操作。
InternalError.QuotaMaxClsLimit 超过配额限制。
InternalError.QuotaMaxNodLimit 超过配额限制。
InternalError.QuotaUSGLimit 安全组配额不足。
InternalError.TaskCreateFailed 创建任务失败
InternalError.UnexceptedInternal 内部错误
InternalError.VpcCommon VPC报错。
InternalError.VpcRecodrNotFound 未发现vpc记录。
InvalidParameter 参数错误
LimitExceeded 超过配额限制
目录