tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreateClusterNodePool

Last updated: 2024-11-14 14:52:48

    1. API Description

    Domain name for API request: tke.tencentcloudapi.com.

    This API is used to create a node pool.

    A maximum of 20 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common Params. The value used for this API: CreateClusterNodePool.
    Version Yes String Common Params. The value used for this API: 2018-05-25.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    ClusterId Yes String Cluster ID
    AutoScalingGroupPara Yes String AS group parameters. For details, see https://www.tencentcloud.com/document/product/377/20440?from_cn_redirect=1
    LaunchConfigurePara Yes String Running parameters. For details, see https://www.tencentcloud.com/document/product/377/20447?from_cn_redirect=1
    InstanceAdvancedSettings Yes InstanceAdvancedSettings InstanceAdvancedSettings
    EnableAutoscale Yes Boolean Indicates whether to enable auto scaling
    Name No String Node pool name
    Labels.N No Array of Label Labels
    Taints.N No Array of Taint Taints
    Annotations.N No Array of AnnotationValue Node Annotation List
    ContainerRuntime No String Node pool runtime type and version
    RuntimeVersion No String Runtime version
    NodePoolOs No String Node pool operating system (enter the image ID for a custom image, and enter the OS name for a public image)
    OsCustomizeType No String Container image tag, DOCKER_CUSTOMIZE (container customized tag), GENERAL (general tag, default value)
    Tags.N No Array of Tag Resource tag
    DeletionProtection No Boolean Whether Deletion Protection is enabled

    3. Output Parameters

    Parameter Name Type Description
    NodePoolId String Node pool ID
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Creating a node pool

    Input Example

    POST / HTTP/1.1
Host: tke.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateClusterNodePool
<Common request parameters>

{
    "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"
}

    Output Example

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

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation.AsCommon An error occurs while creating scaling group resources.
    FailedOperation.ComponentClientHttp Internal HTTP client error.
    FailedOperation.PolicyServerCommonError GPE error.
    FailedOperation.UnexpectedError Unexpected error.
    InternalError.AsCommon Error creating scaling group resource.
    InternalError.ComponentClientHttp Internal HTTP client error
    InternalError.Db DB error.
    InternalError.DbRecordNotFound Record not found.
    InternalError.UnexpectedInternal Unknown internal error.
    InvalidParameter.OsNotSupport The iage OS is not supported.
    InvalidParameter.Param Invalid parameter.
    ResourceNotFound The resource does not exist.
    ResourceNotFound.AsAsgNotExist The scaling group does not exist.
    ResourceUnavailable.ClusterState The cluster’s status does support this operation.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy