tencent cloud

All product documents
Tencent Kubernetes Engine
CreateClusterVirtualNodePool
Last updated: 2024-11-14 14:52:21
CreateClusterVirtualNodePool
Last updated: 2024-11-14 14:52:21

1. API Description

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

This API is used to create the Super 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: CreateClusterVirtualNodePool.
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
Name Yes String Node pool name
SubnetIds.N No Array of String List of subnet IDs
SecurityGroupIds.N No Array of String List of security group IDs
Labels.N No Array of Label Virtual node labels
Taints.N No Array of Taint Virtual node taint
VirtualNodes.N No Array of VirtualNodeSpec List of nodes
DeletionProtection No Boolean Setting of deletion protection
OS No String Node pool OS:
- linux (default value)
- windows

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 Super Node Pool

This example shows you how to create a Super Node Pool.

Input Example

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

{
    "ClusterId": "cls-abcd1234",
    "Name": "vk-nodepoll",
    "SubnetIds": [
        "subnet-abcd1234"
    ],
    "SecurityGroupIds": [
        "sg-abcd1234"
    ]
}

Output Example

{
    "Response": {
        "NodePoolId": "np-abcd1234",
        "RequestId": "1ac0d3ae-063e-4789-93fe-3c73e93191b9"
    }
}

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
InternalError.UnexpectedInternal Unknown internal error.
InvalidParameter.Param Invalid parameter.
InvalidParameter.SubnetInvalidError Invalid subnet.
InvalidParameter.SubnetNotExist The subnet does not exist.
ResourceInUse.SubnetAlreadyExist The subnet already exists.
ResourceNotFound The resource does not exist.
ResourceUnavailable.ClusterState The cluster’s status does support this operation.
UnauthorizedOperation.CamNoAuth The API has no CAM permissions.
UnsupportedOperation.NotSupportInstallVirtualKubelet Virtual nodes cannot be installed.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

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
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon