CreateClusterNodePool

Last updated: 2021-10-20 16:47:32

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 parameter. The value used for this API: CreateClusterNodePool.
Version Yes String Common parameter. The value used for this API: 2018-05-25.
Region Yes String Common parameter. 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
NodePoolOs No String Operating system of the node pool
OsCustomizeType No String Container image tag, DOCKER_CUSTOMIZE (container customized tag), GENERAL (general tag, default value)

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

https://tke.tencentcloudapi.com/?Action=CreateClusterNodePool
&ClusterId=cls-xxxxxx
&AutoScalingGroupPara={"AutoScalingGroupName":"","MaxSize":1,"MinSize":0,"DesiredCapacity":1,"VpcId":"vpc-xxx","SubnetIds":["subnet-xxx"],"RetryPolicy":"IMMEDIATE_RETRY","ServiceSettings":{"ScalingMode":"CLASSIC_SCALING"}}
&LaunchConfigurePara={"LaunchConfigurationName":"","InstanceType":"SA2.SMALL1","SystemDisk":{"DiskType":"CLOUD_PREMIUM","DiskSize":50},"InternetAccessible":{"InternetChargeType":"TRAFFIC_POSTPAID_BY_HOUR","InternetMaxBandwidthOut":0,"PublicIpAssigned":false},"LoginSettings":{"Password":"xxx"},"SecurityGroupIds":["sg-xxx"],"EnhancedService":{"SecurityService":{"Enabled":true},"MonitorService":{"Enabled":true}},"InstanceChargeType":"POSTPAID_BY_HOUR"}
&InstanceAdvancedSettings.MountTarget=xxx
&EnableAutoscale=true
&<Common request parameters>

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
InternalError.AsCommon Error creating scaling group resource.
InternalError.Db DB error.
InternalError.DbRecordNotFound Record not found.
InternalError.UnexpectedInternal Unknown internal error.
InvalidParameter.Param Invalid parameter.
ResourceNotFound.AsAsgNotExist The scaling group does not exist.
ResourceUnavailable.ClusterState The cluster’s status does support this operation.