创建集群

最近更新时间:2024-05-07 01:28:39

我的收藏

1. 接口描述

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

创建集群

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateCluster。
Version String 公共参数,本接口取值:2018-03-26。
Region String 公共参数,详见产品支持的 地域列表
ClusterName String 集群名称
示例值:DEMO-DOCKER
ClusterType String 集群类型
示例值:C
VpcId String 私有网络ID
示例值:vpc-xxxxxxx
ClusterCIDR String 分配给集群容器和服务IP的CIDR
示例值:172.16.0.0/16
ClusterDesc String 集群备注
示例值:desc
TsfRegionId String 集群所属TSF地域
示例值:ap-guangzhou
TsfZoneId String 集群所属TSF可用区
示例值:100004
SubnetId String 私有网络子网ID
示例值:id
ClusterVersion String 集群版本
示例值:1
MaxNodePodNum Integer 集群中每个Node上最大的Pod数量。取值范围4~256。不为2的幂值时会向上取最接近的2的幂值。
示例值:1
MaxClusterServiceNum Integer 集群最大的service数量。取值范围32~32768,不为2的幂值时会向上取最接近的2的幂值。
示例值:1
ProgramId String 需要绑定的数据集ID
示例值:1
KuberneteApiServer String api地址
示例值:1
KuberneteNativeType String K : kubeconfig, S : service account
示例值:K
KuberneteNativeSecret String native secret
示例值:1
ProgramIdList.N Array of String
EnableLogCollection Boolean 是否开启cls日志功能
示例值:false

3. 输出参数

参数名称 类型 描述
Result String 集群ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建集群

创建集群

输入示例

POST / HTTP/1.1
Host: tsf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateCluster
<公共请求参数>

{
    "VpcId": "vpc-xxxxxxx",
    "ClusterName": "DEMO-DOCKER",
    "TsfZoneId": "100004",
    "ClusterType": "C",
    "ClusterCIDR": "172.16.0.0/16",
    "TsfRegionId": "ap-guangzhou"
}

输出示例

{
    "Response": {
        "Result": "abc",
        "RequestId": "abc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.CloudApiProxyError TSF云API请求调用失败。
FailedOperation.ClusterCreateVpcFail 创建集群,开通VPC网络权限失败。
FailedOperation.ClusterQueryFailed 查询集群失败。
FailedOperation.TkeClusterCreateFailed TKE 集群创建失败,%s。
FailedOperation.UnhandledException 模块未处理异常。
InternalError.CloudApiProxyError TSF云API请求调用失败。
InternalError.ClusterCommonError 集群通用错误。
InternalError.ClusterMasterFeignError 虚拟机集群请求MASTER FEIGN失败。
InternalError.UnhandledException [%s]模块未处理异常。。
InvalidParameter.ParamError 参数错误。
InvalidParameterValue.ClusterCidrConflict 与同VPC其它集群CIDR冲突。
InvalidParameterValue.ClusterNameExist 集群命名已存在,请更换其他名称。
InvalidParameterValue.ClusterNameRequired 集群命名不能为空。
InvalidParameterValue.ClusterRegionInvalid 创建集群,无效的地域字段。
InvalidParameterValue.ClusterTypeInvalid 非法集群类型。
InvalidParameterValue.ClusterZoneInvalid 创建集群,无效的可用区字段。
LimitExceeded.TkeClusterNumberExceedLimit 最多支持创建五个容器集群,当前已经超过使用上限。
MissingParameter.ClusterSubnetRequired 集群所属子网不能为空。
ResourceNotFound.ClusterNotExist 无法获取命名空间所属集群。
ResourceNotFound.ClusterVpcNotExist 集群所属私有网络不存在。
UnauthorizedOperation.CamGeneralError 访问 CAM 系统出错,%s。
UnauthorizedOperation.CamTsfRoleNotExist 当前主账号未创建TSF_QCSRole或未对子账号授予预设策略QcloudCamSubaccountsAuthorizeRoleFullAccess。请参考产品文档主账号协作者使用说明。。
UnauthorizedOperation.NoPrivilege 用户无权限访问该接口。。