有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

创建节点池

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateClusterNodePool。
Version String 公共参数,本接口取值:2018-05-25。
Region String 公共参数,详见产品支持的 地域列表
ClusterId String cluster id
示例值:cls-xxxxxx
AutoScalingGroupPara String AutoScalingGroupPara AS组参数,参考 https://cloud.tencent.com/document/product/377/20440
示例值:{"AutoScalingGroupName":"","MaxSize":20,"MinSize":0,"DesiredCapacity":2,"VpcId":"vpc-2ln96dly","SubnetIds":["subnet-40bgrdix"],"MultiZoneSubnetPolicy":"PRIORITY","RetryPolicy":"IMMEDIATE_RETRY","ServiceSettings":{"ScalingMode":"CLASSIC_SCALING"}}
LaunchConfigurePara String LaunchConfigurePara 运行参数,参考 https://cloud.tencent.com/document/product/377/20447
示例值:{"LaunchConfigurationName":"","InstanceType":"S6.8XLARGE64","SystemDisk":{"DiskType":"CLOUD_BSSD","DiskSize":50},"DataDisks":[{"DiskType":"CLOUD_BSSD","DiskSize":500}],"InternetAccessible":{"InternetChargeType":"TRAFFIC_POSTPAID_BY_HOUR","InternetMaxBandwidthOut":0,"PublicIpAssigned":false},"LoginSettings":{"KeyIds":["skey-xxxxx"]},"SecurityGroupIds":["sg-xxxxxx"],"EnhancedService":{"SecurityService":{"Enabled":true},"MonitorService":{"Enabled":true}},"HostNameSettings":{"HostName":"foundation-node","HostNameStyle":"UNIQUE"},"InstanceNameSettings":{"InstanceName":"node","InstanceNameStyle":"UNIQUE"},"InstanceChargeType":"PREPAID","InstanceChargePrepaid":{"Period":1,"RenewFlag":"NOTIFY_AND_AUTO_RENEW"}}
InstanceAdvancedSettings InstanceAdvancedSettings InstanceAdvancedSettings
EnableAutoscale Boolean 是否启用自动伸缩
示例值:true
Name String 节点池名称
示例值:测试集群
Labels.N Array of Label Labels标签
Taints.N Array of Taint Taints互斥
Annotations.N Array of AnnotationValue 节点Annotation 列表
示例值:[]
ContainerRuntime String 节点池纬度运行时类型及版本
示例值:docker
RuntimeVersion String 运行时版本
示例值:18.06
NodePoolOs String 节点池os,当为自定义镜像时,传镜像id;否则为公共镜像的osName
示例值:ubuntu18.04.1x86_64
OsCustomizeType String 容器的镜像版本,"DOCKER_CUSTOMIZE"(容器定制版),"GENERAL"(普通版本,默认值)
示例值:GENERAL
Tags.N Array of Tag 资源标签
DeletionProtection Boolean 删除保护开关
示例值:false

3. 输出参数

参数名称 类型 描述
NodePoolId String 节点池id
示例值:np-xxxxxxxx
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建节点池

输入示例

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

{
    "AutoScalingGroupPara": "{\"AutoScalingGroupName\":\"\",\"MaxSize\":20,\"MinSize\":0,\"DesiredCapacity\":2,\"VpcId\":\"vpc-2ln96dly\",\"SubnetIds\":[\"subnet-40bgrdix\"],\"MultiZoneSubnetPolicy\":\"PRIORITY\",\"RetryPolicy\":\"IMMEDIATE_RETRY\",\"ServiceSettings\":{\"ScalingMode\":\"CLASSIC_SCALING\"}}",
    "ClusterId": "cls-xxxxxxx",
    "ContainerRuntime": "docker",
    "DeletionProtection": true,
    "EnableAutoscale": true,
    "InstanceAdvancedSettings": {
        "DataDisks": [
            {
                "AutoFormatAndMount": true,
                "DiskSize": 500,
                "DiskPartition": "xxx",
                "DiskType": "CLOUD_BSSD",
                "FileSystem": "xfs",
                "MountTarget": "/var/lib/docker"
            }
        ],
        "Taints": [
            {
                "Value": "value",
                "Key": "key",
                "Effect": "NoExecute"
            }
        ],
        "DockerGraphPath": "/var/lib/docker",
        "DesiredPodNumber": 0,
        "PreStartUserScript": "xxxx",
        "GPUArgs": {
            "CUDA": {
                "Name": "",
                "Version": ""
            },
            "CUDNN": {
                "DevName": "",
                "DocName": "",
                "Name": "",
                "Version": ""
            },
            "Driver": {
                "Name": "",
                "Version": ""
            },
            "MIGEnable": false
        },
        "Unschedulable": 0,
        "UserScript": "Y3VybCAtcyxxxxxxxxxxxxxcmVzb2x2LmNvbmY="
    },
    "Taints": [
        {
            "Value": "value",
            "Key": "key",
            "Effect": "NoExecute"
        }
    ],
    "Labels": [
        {
            "Name": "node-pool",
            "Value": "xxxx"
        }
    ],
    "Annotations": [
        {
            "Name": "tke.cloud.tencent.com/test",
            "Value": "true"
        }
    ],
    "LaunchConfigurePara": "{\"LaunchConfigurationName\":\"\",\"InstanceType\":\"S6.8XLARGE64\",\"SystemDisk\":{\"DiskType\":\"CLOUD_BSSD\",\"DiskSize\":50},\"DataDisks\":[{\"DiskType\":\"CLOUD_BSSD\",\"DiskSize\":500}],\"InternetAccessible\":{\"InternetChargeType\":\"TRAFFIC_POSTPAID_BY_HOUR\",\"InternetMaxBandwidthOut\":0,\"PublicIpAssigned\":false},\"LoginSettings\":{\"KeyIds\":[\"skey-xxxxx\"]},\"SecurityGroupIds\":[\"sg-xxxxxx\"],\"EnhancedService\":{\"SecurityService\":{\"Enabled\":true},\"MonitorService\":{\"Enabled\":true}},\"HostNameSettings\":{\"HostName\":\"foundation-node\",\"HostNameStyle\":\"UNIQUE\"},\"InstanceNameSettings\":{\"InstanceName\":\"node\",\"InstanceNameStyle\":\"UNIQUE\"},\"InstanceChargeType\":\"PREPAID\",\"InstanceChargePrepaid\":{\"Period\":1,\"RenewFlag\":\"NOTIFY_AND_AUTO_RENEW\"}}",
    "Name": "node-pool",
    "NodePoolOs": "centos7.6.0_x64",
    "OsCustomizeType": "GENERAL",
    "RuntimeVersion": "19.3"
}

输出示例

{
    "Response": {
        "NodePoolId": "np-xxx",
        "RequestId": "xxx-xxx-xxxx-xxx-xxxxx"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.AsCommon 伸缩组资源创建报错。
FailedOperation.ComponentClientHttp 内部HTTP客户端错误。
FailedOperation.PolicyServerCommonError gpe错误。
FailedOperation.UnexpectedError 不可预知的错误。
InternalError.AsCommon 伸缩组资源创建报错。
InternalError.ComponentClientHttp 内部HTTP客户端错误。
InternalError.Db db错误。
InternalError.DbRecordNotFound 记录未找到。
InternalError.UnexpectedInternal 未知的内部错误。
InvalidParameter.OsNotSupport 镜像OS不支持。
InvalidParameter.Param 参数错误。
ResourceNotFound 资源不存在。
ResourceNotFound.AsAsgNotExist 伸缩组不存在。
ResourceUnavailable.ClusterState 集群状态不支持该操作。