tencent cloud

Feedback

CreateClusterNodePool

Last updated: 2022-09-19 11:05:05

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
LaunchConfigurePara Yes String Running parameters
InstanceAdvancedSettings Yes InstanceAdvancedSettings Sample parameters
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
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, which is returned for each request. 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>

{
    "InstanceAdvancedSettings": {
        "PreStartUserScript": "xx",
        "DockerGraphPath": "xx",
        "Labels": [
            {
                "Name": "xx",
                "Value": "xx"
            }
        ],
        "ExtraArgs": {
            "Kubelet": [
                "xx"
            ]
        },
        "Taints": [
            {
                "Value": "xx",
                "Key": "xx",
                "Effect": "xx"
            }
        ],
        "Unschedulable": 0,
        "UserScript": "xx",
        "DesiredPodNumber": 0,
        "GPUArgs": {
            "MIGEnable": true,
            "CustomDriver": {
                "Address": "xx"
            },
            "Driver": {
                "Version": "xx",
                "Name": "xx"
            },
            "CUDA": {
                "Version": "xx",
                "Name": "xx"
            },
            "CUDNN": {
                "DocName": "xx",
                "Version": "xx",
                "Name": "xx",
                "DevName": "xx"
            }
        },
        "MountTarget": "xx",
        "DataDisks": [
            {
                "DiskPartition": "xx",
                "DiskType": "xx",
                "DiskSize": 0,
                "FileSystem": "xx",
                "AutoFormatAndMount": true,
                "MountTarget": "xx"
            }
        ]
    },
    "LaunchConfigurePara": "xx",
    "OsCustomizeType": "xx",
    "Name": "xx",
    "RuntimeVersion": "xx",
    "Tags": [
        {
            "Value": "xx",
            "Key": "xx"
        }
    ],
    "Labels": [
        {
            "Name": "xx",
            "Value": "xx"
        }
    ],
    "ClusterId": "xx",
    "Taints": [
        {
            "Value": "xx",
            "Key": "xx",
            "Effect": "xx"
        }
    ],
    "EnableAutoscale": true,
    "ContainerRuntime": "xx",
    "AutoScalingGroupPara": "xx",
    "NodePoolOs": "xx"
}

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.
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.
Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support