You need to enable JavaScript to run this app.
Volcengine Kubernetes Engine

Volcengine Kubernetes Engine

Copy page
Download PDF
NodePool management
UpdateNodePoolConfig
Copy page
Download PDF
UpdateNodePoolConfig
Update the configurations of a node pool in a specified cluster.​
Request description​
VKE has deployed services in multiple regions globally to provide a stable and low-latency access experience. See Service addresses and select the most suitable endpoint for the region where your business operates.​
  • Request method: POST​
  • Request URL: https://vke.cn-beijing.volcengineapi.com?Action=UpdateNodePoolConfig&Version=2022-05-12​
Debugging​
API Explorer
You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.
​
Request parameters​
The following table describes the API request parameters. You also need to provide public parameters when calling this API. For details about public request parameters, see Public parameters.​
​
Parameter​
Type​
Required​
Sample value​
Description​
Action​
String​
Yes​
UpdateNodePoolConfig​
The API name. The name of the current API is UpdateNodePoolConfig.​
Version​
String​
Yes​
May 12, 2022​
The API version. The API version is 2022-05-12.​
ClientToken​
String​
No​
BC028527-33B9-4990-A633-84E9F9******​
A string used to ensure the idempotency of the request. This string is passed in by the caller and must be unique across different requests. ClientToken is case-sensitive and can consist of 64 ASCII characters at most.​
ClusterId​
String​
Yes​
cc5silu*******​
The ID of the cluster where the node pool is located.​
You can call the ListClusters API to obtain cluster IDs.​
warning​
The cluster must be in the {Running,[*]} or {Updating, [Progressing]} state. You can call the ListClusters API to obtain the current status of the cluster.​
Id​
String​
Yes​
pc51i0*******​
The node pool ID.​
You can call the ListNodePools API to obtain the node pool ID.​
warning​
The node pool must be in the {Running,[*]} or {Scaling,[Progressing]} state. You can call the ListNodePools API to obtain the current status of the node pool.​
Name​
String​
No​
test-nodepool​
The name of the node pool.​
  • The node pool name must be unique within the same cluster.​
  • It can contain uppercase and lowercase letters, Chinese characters, digits, and hyphens (-). It can be 2 to 64 characters in length.​
warning​
The default node pool name vke-default-nodepool cannot be used.​
KubernetesConfig​
No​
-​
The Kubernetes configurations of the node pool.​
NodeConfig​
Object of NodeConfigForUpdate​
No​
-​
The ECS instance configuration for the node pool.​
AutoScaling​
No​
-​
The node pool scaling policy.​
tip​
You cannot modify the scaling policy of the default node pool vke-default-nodepool.​
Management​
No​
-​
The management configuration of the node pool.​
​
NodePoolKubernetesConfigRequest​
​
Parameter​
Type​
Required​
Sample value​
Description​
Labels​
Array of Label​
No​
-​
The Kubernetes labels of the node pool or the node. Up to 20 labels can be provided.​
tip​
The node pool manages the label configurations of nodes in a centralized manner. Therefore, the label information will be synchronized to all nodes in the node pool. When labels are changed, the original label configurations will be overwritten.​
Taints​
Array of Taint​
No​
-​
The Kubernetes taints of the node pool or the node. Up to 20 taints can be specified.​
tip​
The node pool manages the taint configurations of nodes in a centralized manner. Therefore, the taint information will be synchronized to all nodes in the node pool. When taints are changed, the original taint configurations will be overwritten.​
Cordon​
Boolean​
No​
false​
Whether to cordon nodes. Valid values:​
  • false: Disable node cordoning.​
  • true: Enable node cordoning.​
tip​
When you update the configurations of a node pool, if you do not specify this parameter, the original parameter configurations are retained.​
NamePrefix​
String​
No​
name-prefix​
The prefix of the metadata name for the node object in Kubernetes. The prefix is validated based on the following rules:​
  • It can contain lowercase letters, digits, hyphens (-), and periods (.).​
  • It can start only with a lowercase letter or digit.​
  • It can be 1 to 48 characters in length.​
KubeletConfig​
No​
-​
Specify custom kubelet parameters for nodes in the node pool to adjust node behavior.​
warning​
The default node pool does not support custom kubelet configuration, and the related sub-parameters that have been specified do not take effect.​
AutoSyncDisabled​
Boolean​
No​
false​
Whether to disable automatic synchronization of labels and taints to existing nodes. Values:​
  • true: Disable automatic synchronization.​
  • false: Enable automatic synchronization.​
Runtime​
No​
-​
Container runtime configuration.​
NameSuffix​
String​
No​
-demo​
The suffix of the metadata name for the node object in Kubernetes.​
NameUseHostname​
Boolean​
No​
true​
Specify whether the metadata name of the node object in Kubernetes uses the ECS hostname. Valid values:​
  • true: Use the ECS hostname as the node name.​
  • false: Does not use the ECS hostname as the node name.​
tip​
This configuration has higher priority than NamePrefix and NameSuffix.​
ContainerdConfig​
No​
-​
The containerd-related configurations of the node pool.​
warning​
The default node pool does not support containerd configuration, and the related sub-parameters that have been specified do not take effect.​
​
Label​
​
Parameter​
Type​
Required​
Sample value​
Description​
Key​
String​
Yes​
label-key​
The label key. The requirements are as follows. For more rules, see Kubernetes label rules.​
A valid label key consists of <prefix> and <Name>, which are separated by a slash (/).​
  • <Name> is required, which can contain uppercase or lowercase letters, digits, hyphens (-), underscores (_), and periods (.). It must start and end with a letter or digit and can be up to 63 characters in length.​
  • <prefix> is optional. If <prefix> is specified, it must be a DNS subdomain. It is a series of DNS labels separated by periods (.), with a length not exceeding 253 characters.​
  • The total length of <prefix> and <Name> must not exceed 82 characters.​
Value​
String​
No​
label-value​
The label value. The requirements are as follows. For more rules, see Kubernetes label rules.​
  • The value cannot exceed 63 characters in length and can be left empty.​
  • The value can start and end with an uppercase or lowercase letter, or a digit.​
  • The value can contain the following special characters: hyphens (-), underscores (_), and periods (.).​
​
Taint​
​
Parameter​
Type​
Required​
Sample value​
Description​
Key​
String​
Yes​
taint-key​
The taint key. The requirements are as follows. For more rules, see Kubernetes label rules.​
A valid taint key consists of a prefix and a name, which are separated by a slash (/).​
  • The name is required. It can contain uppercase and lowercase letters, digits, and the following special characters: - _ .. It must start and end with a letter or digit, and can be up to 63 characters in length.​
  • The prefix is optional. If you specify the prefix, it must be a DNS subdomain: a series of DNS labels separated by periods (.). It can be up to 253 characters in length.​
  • The total length of the prefix and name cannot exceed 82 characters.The prefix and name can consist of 82 characters in total.​
Value​
String​
No​
taint-value​
The taint value. The requirements are as follows. For more rules, see Kubernetes label rules.​
  • The value cannot exceed 63 characters in length and can be left empty.​
  • The value can start and end with an uppercase or lowercase letter, or a digit.​
  • The following special characters are supported: - _ .​
Effect​
String​
No​
NoSchedule​
The taint effect. Valid values:​
  • NoSchedule: No scheduling is performed.​
  • NoExecute: Pods that do not tolerate the taint are evicted.​
  • PreferNoSchedule: Avoid scheduling if possible.​
​
NodePoolKubeletConfig​
​
Parameter​
Type​
Required​
Sample value​
Description​
FeatureGates​
Object of FeatureGates​
No​
-​
The feature gates, which are a set of key-value pairs that describe Kubernetes features.​
TopologyManagerScope​
String​
No​
container​
The resource granularity of the topology management policy. Valid values:​
  • container: The resource alignment granularity is at the container level.​
TopologyManagerPolicy​
String​
No​
none​
The topology management policy. Valid values:​
  • none: No topology management policy is enabled.​
  • restricted: Kubelet accepts only pods that achieve optimal non-uniform memory access (NUMA) alignment on the requested resources.​
  • best-effort: Kubelet preferentially selects pods that achieve NUMA alignment on CPU and device resources.​
  • single-numa-node: Kubelet allows only pods that are aligned to the same NUMA node in terms of CPU and device resources.​
MaxPods​
Integer​
No​
110​
The maximum number of pods supported by the node.​
KubeApiQps​
Integer​
No​
50​
The number of QPS for communication with the API server. The value is an integer. Valid values: 1 to 500.​
KubeApiBurst​
Integer​
No​
100​
The maximum burst requests sent to the API server per second. Enter an integer from 1 to 1000.​
tip​
This value must be greater than or equal to the value of the KubeApiQps parameter.​
CpuCfsQuota​
Boolean​
No​
false​
Whether to enable CPU CFS quota guarantee for containers with CPU limits.​
  • true: Enable this feature.​
  • false: Disable this feature.​
EvictionHard​
Array of EvictionHard​
No​
-​
A set of hard eviction thresholds that trigger pod eviction. For detailed parameter descriptions, see the official documentation.​
To explicitly disable hard eviction, set the threshold to 0% or 100% on any resource.​
KubeReserved​
Array of ComputeResource​
No​
-​
The resources reserved by the node for Kubernetes system components. By default, resources are reserved based on half of the default value in the node resource reservation policy.​
SystemReserved​
Array of ComputeResource​
No​
-​
The resources reserved for the operating system on the node. By default, resources are reserved based on half of the default value in the node resource reservation policy.​
RegistryPullQps​
Integer​
No​
5​
The QPS threshold for a cluster pulling images from Container Registry (CR). The value is an integer. Valid values: 1 to 50.​
RegistryBurst​
Integer​
No​
10​
The maximum images concurrently pulled from CR. The value is an integer. Valid values: 1 to 100.​
tip​
You need to specify this parameter only when the value of the RegistryPullQps parameter is greater than 0. The value of this parameter must be greater than or equal to the value of the RegistryPullQps parameter.​
SerializeImagePulls​
Boolean​
No​
true​
Specify whether to serially pull images. Valid values:​
  • true: Serially pull images.​
  • false: (Default) Pull images in parallel to accelerate pod startup.​
CpuManagerPolicy​
String​
No​
none​
The CPU manager policy. Valid values:​
  • none: The policy is the default policy.​
  • static: This policy allows pods with specific resource characteristics on the node to be granted enhanced CPU affinity and exclusivity.​
FailSwapOn​
Boolean​
No​
false​
Specifies whether kubelet can run when swap is enabled on the node. Valid values:​
  • true: Prevents kubelet from running when swap is enabled on the node. This is the default value. This is the default protection mechanism in Kubernetes. Swap can interfere with precise memory limit control. As a result, containers may use more memory than expected, affecting the accuracy of Pod scheduling and out-of-memory (OOM) detection.​
  • false: Allows kubelet to run when swap is enabled on the node. This option applies when strict memory isolation is not required or when Kubernetes must run on existing nodes with swap configured.​
PodPidsLimit​
Integer​
No​
4096​
This parameter limits the maximum number of process IDs (PIDs) that all containers in a single Pod can use. This prevents a single Pod from creating excess processes and exhausting the PID resources of the node.​
  • The value is an integer. Valid values: -1 or a positive integer. Unit: count.​
  • When the value is set to -1, it indicates that the number of PIDs that a single Pod can use is not limited.​
tip​
  • This configuration only limits the number of PIDs that a single Pod can use. The actual number of PIDs available to a Pod is also affected by the PID limit of the node kernel and the PID usage of other processes on the node.​
  • We do not recommend setting the value to -1. We recommend setting the value based on the PID capacity of the node, the number of processes required by each Pod, and the number of Pods the node can run. This prevents a single Pod from exhausting the PID resources of the node. In addition, do not set a value that is too low. Otherwise, the Pod cannot create processes as expected.​
ImageMaximumGcAge​
String​
No​
24h​
The maximum retention duration for unused images before they are garbage collected. Images that have remained unused for longer than this period will be cleaned up during the next garbage collection cycle.​
  • The Kubernetes duration. The value is a string. It supports time units, such as 48h and 168h.​
  • The default value is 0s, which indicates that images are not cleaned up based on time limits and are garbage collected only based on disk utilization (ImageGcHighThresholdPercent).​
warning​
  • When this parameter is set to a non-zero value, the value must be greater than ImageMinimumGcAge.​
  • This parameter is supported only in clusters running on Kubernetes v1.30 or later.​
ImageMinimumGcAge​
String​
No​
5m​
The minimum retention duration for unused images before they are garbage collected. During this time, the image will not be garbage collected even if disk utilization exceeds the garbage collection threshold.​
  • The Kubernetes duration. The value is a string. It supports time units, such as 2m and 30m.​
  • The default value is 2m.​
  • This parameter prevents a newly pulled image from being garbage collected immediately. This keeps the image available during the window between the pull and container startup.​
tip​
Do not set a value that is too high. Otherwise, newly downloaded images that are not used in the short term cannot be cleaned up in time when disk space is tight. This potentially increases disk pressure.​
ImageGcLowThresholdPercent​
Integer​
No​
80​
The threshold for stopping Image garbage collection. During image garbage collection, collection stops when disk usage falls below this percentage.​
  • The value is an integer. Valid values: 0 to 100.​
  • Default value: 80.​
  • Unit: percentage.​
warning​
  • When specifying this parameter, make sure that ImageGcLowThresholdPercent is less than ImageGcHighThresholdPercent. Even if only one of the parameters is modified, the system validates it against the default value or the original configuration of the other parameter.​
  • You can set this parameter to 0. However, this value stops cleanup only after disk usage reaches 0%, which is almost impossible and has no practical value.​
ImageGcHighThresholdPercent​
Integer​
No​
85​
The threshold for triggering image garbage collection. When disk utilization exceeds this value, garbage collection will be triggered. Unused images will be cleaned up to release disk space.​
  • The value is an integer. Valid values: 0 to 100.​
  • Default value: 85.​
  • Unit: percentage.​
warning​
  • When specifying this parameter, make sure that ImageGcLowThresholdPercent is less than ImageGcHighThresholdPercent. Even if only one of the parameters is modified, the system validates it against the default value or the original configuration of the other parameter.​
  • You can set this parameter to 100. However, this value triggers cleanup only when disk usage reaches 100%. This value is extremely conservative and not recommended in production environments.​
​
FeatureGates​
​
Parameter​
Type​
Required​
Sample value​
Description​
QoSResourceManager​
Boolean​
No​
false​
Specify whether to enable quality of service (QoS) Resource Manager to support micro-topology scheduling. Valid values:​
  • true: Enable QoS Resource Manager.​
  • false: Do not enable QoS Resource Manager.​
tip​
This configuration takes effect only in clusters of the following versions:​
  • v1.24.15-vke.13 ≤ Cluster version < v1.26​
  • v1.26.10-vke.13 ≤ Cluster version < v1.28​
InPlacePodVerticalScaling​
Boolean​
No​
true​
Specify whether to enable the vertical scaling feature for pods. Valid values:​
  • true: Enable the vertical scaling feature for pods.​
  • false: Disable it.​
warning​
This configuration is supported only by the following cluster versions. Attempting to configure it on clusters of other versions is not allowed and will result in an error:​
  • v1.28.3-vke.17 ≤ Custer version < v1.36​
​
EvictionHard​
​
Parameter​
Type​
Required​
Sample value​
Description​
Key​
String​
Yes​
memory.available​
The name of the hard eviction threshold. Valid values:​
  • memory.available​
  • nodefs.available​
  • nodefs.inodesFree​
  • imagefs.available​
Value​
String​
Yes​
1Gi​
The hard eviction threshold value. The value can be an integer or a percentage.​
  • If the value is an integer, it indicates the specific threshold value of the resource. Unit: bytes. For example: 100Mi.​
  • If the value is a percentage, it indicates the proportion of the resource threshold value. Valid values: 0% to 100%. For example: 20%. To explicitly disable hard eviction, set the threshold to 0% or 100% on any resource.​
​
ComputeResource​
​
Parameter​
Type​
Required​
Sample value​
Description​
Name​
String​
Yes​
cpu​
Resource name. The value is cpu or memory.​
Quantity​
String​
Yes​
1G​
Specify the quantity of the resource.​
  • When the resource is cpu, the example value is 200m.​
  • When the resource is memory, the sample value is 1 GB.​
​
NodePoolRuntimeRequest​
​
Parameter​
Type​
Required​
Sample value​
Description​
Type​
String​
No​
containerd​
Container runtime type. Values:​
  • containerd: The containerd runtime.​
Version​
String​
No​
1.6.38​
Container runtime version in the x.x.x format.​
For a list of containerd versions for VKE, see the containerd release notes.​
warning​
The new containerd version after the update applies only to newly provisioned nodes in the node pool.​
​
NodePoolContainerdConfig​
​
Parameter​
Type​
Required​
Sample value​
Description​
ConcurrentLayerFetchBuffer​
Integer​
No​
512​
The buffer size used when a single image layer is concurrently pulled in chunks. The value is a positive integer. Unit: bytes.​
tip​
This parameter is supported only if the containerd version is v2.1.0 or later.​
MaxConcurrentUnpacks​
Integer​
No​
8​
The maximum number of image layers that containerd can decompress simultaneously.​
  • The value is a positive integer. Default value: 1.​
  • This parameter takes effect only if UseLocalImagePull is set to false.​
tip​
This parameter is supported only if the containerd version is v2.2.0 or later.​
MaxConcurrentDownloads​
Integer​
No​
10​
The maximum number of image layers that containerd can download concurrently when pulling images at a time.​
  • The value is a positive integer. Default value: 3.​
  • If you do not specify this parameter, the default value is used.​
tip​
This parameter is supported only if the containerd version is v2.1.0 or later.​
UseLocalImagePull​
Boolean​
No​
true​
The image pull mode of containerd. Valid values:​
  • true: (Default) Use a local client to pull images.​
  • false: Use Transfer Service to pull images.​
tip​
This parameter is supported only if the containerd version is v2.1.0 or later.​
​
NodeConfigForUpdate​
​
Parameter​
Type​
Required​
Sample value​
Description​
InstanceTypeIds​
Array of String​
No​
["ecs.g1ie.large"]​
The IDs of the ECS instance specifications that correspond to nodes. If you specify this parameter, it indicates that the original specifications of the node pool are updated. After the specifications are updated, nodes are scaled out based on the new specifications, and the existing nodes of the original specifications are not affected.​
Call the ListSupportedResourceTypes API to query the resource types and scope supported by a cluster.​
warning​
  • You can enter up to 10 array elements.​
  • When updating the specification configuration of a node pool, you can replace GPU-type specifications only with other GPU-type specifications, and non-GPU specifications only with other non-GPU specifications.​
  • You cannot replace the value with ECS instance specifications that have been discontinued.​
SubnetIds​
Array of String​
No​
["subnet-3rf6wbg******"]​
The IDs of the subnets to which the node network belongs.​
You can call the VPC API to obtain subnet IDs.​
warning​
  • The subnets must be in the same VPC as the cluster.​
  • If you specify this parameter, you need to provide all subnet IDs, and you can only add subnet IDs based on the existing subnet IDs of the node pool instead of removing existing subnet IDs.​
  • A node pool can be associated with up to eight subnet IDs.​
SystemVolume​
Object of SystemVolume​
No​
-​
The system volume configurations of the node.​
Call the DescribeInstanceTypes API of ECS to obtain the matching relationship between ECS instance families and cloud disk specifications.​
DataVolumes​
Array of DataVolume​
No​
-​
The data volumes of nodes.​
Call the DescribeInstanceTypes API of ECS to obtain the matching relationship between ECS instance families and cloud disk specifications.​
AdditionalContainerStorageEnabled​
Boolean​
No​
false​
Specify whether to format and mount the first data volume of the node as the storage directory for container images and logs. Valid values:​
  • false: Disable it.​
  • true: Enable this option.​
InitializeScript​
String​
No​
ZWNoby******​
The custom script that is executed after a node is created and initialized.​
The script supports the shell format, and you need to Base64-encode the script content before passing it in.​
tip​
Base64-encoded content can be up to 8 KB in length. If you specify both the InitializeScript and PreScript parameters, the total length of the two parameter values cannot exceed 8 KB.​
Security​
No​
-​
The node security configurations.​
Period​
Integer​
No​
12​
The purchase duration of the ECS instance. Unit: months. Valid values:​
1, 2, 3, 4, 5, 6, 7, 8, 9, 12, 24, and 36.​
tip​
  • This parameter can be modified only when the InstanceChargeType parameter is set to PrePaid for the node pool.​
  • This configuration only takes effect on newly added nodes. For existing nodes, go to the ECS console to manually modify their configurations.​
AutoRenew​
Boolean​
No​
true​
Specify whether automatic renewal is enabled for the ECS instance upon expiration. Valid values:​
  • true: Enables automatic renewal.​
  • false: Does not enable automatic renewal.​
tip​
  • This parameter can be modified only when the InstanceChargeType parameter is set to PrePaid for the node pool.​
  • This configuration only takes effect on newly added nodes. For existing nodes, go to the ECS console to manually modify their configurations.​
AutoRenewPeriod​
Integer​
No​
1​
The automatic renewal duration for the ECS instance. Unit: months. Valid values:​
1, 2, 3, 6, and 12.​
tip​
  • This parameter can be modified only when the InstanceChargeType parameter is set to PrePaid for the node pool, and can take effect only when AutoRenew is set to true.​
  • This configuration only takes effect on newly added nodes. For existing nodes, go to the ECS console to manually modify their configurations.​
NamePrefix​
String​
No​
prefix-name​
The prefix of the node name. If this parameter is left empty, the node name prefix is not used. The prefix is validated based on the following rules:​
  • The prefix can contain uppercase and lowercase letters, digits, and hyphens (-).​
  • The prefix can only start with a letter and end with a letter or digit.​
  • Hyphens (-) cannot be used consecutively.​
  • The prefix can be 2 to 51 characters in length.​
Tags​
Array of Tag​
No​
-​
The tags added to the ECS instances that correspond to nodes. The tags are used for filtering and managing ECS instances.​
  • Each Key in Tags must be unique.​
  • If the resource already has the same Tags.Key, an error will not occur if you bind the same Tags.Key again. Instead, the latest Tags.Value will be used.​
  • Up to 20 tags can be added to a single resource.​
  • The Key and Value in Tags cannot start or end with a space.​
HpcClusterIds​
Array of String​
No​
["hpcCluster-1"]​
The ID of the high-performance computing (HPC) cluster.​
  • When you change the specification of the node pool from GPU Accelerated to High Performance Computing Optimized, you need to specify the ID of an HPC cluster. Obtain the ID on the Instances & Images > HPC Cluster page in the ECS console.​
tip​
  • Make sure that the specified HPC cluster and the subnets specified in SubnetIds are located in the same availability zone.​
  • When you change the specification of the node pool from High Performance Computing Optimized to GPU Accelerated, you need to enter an empty array to clear the existing HPC cluster ID.​
InstancesDistribution​
No​
-​
Configure the blending policy for spot instances and pay-as-you-go instances. This policy takes effect when SpotStrategy is set to SpotAsPriceGo.​
ImageId​
String​
No​
image-kd********​
The ID of the image used by the ECS instance that corresponds to the node.​
Image IDs vary based on different types of images. For details, see Public images supported by VKE.​
warning​
  • If this parameter is not specified, an image ID from the veLinux 2.0 series is preferentially allocated.​
  • This parameter is required when multiple specifications are provided.​
ProjectName​
String​
No​
default​
The project name of the ECS instances added to the node pool during scale-out. Each ECS instance can only belong to one project.​
  • It can only contain letters, digits, underscores (_), dots (.), and hyphens (-).​
  • It can be up to 64 characters in length.​
PublicAccessEnabled​
Boolean​
No​
false​
Specify whether to automatically bind EIPs to nodes. Valid values:​
  • true: Enabled. The system automatically binds EIPs to nodes in the cluster. In this case, you also need to specify the PublicAccessConfig parameter to specify custom EIPs.​
PublicAccessConfig​
Object of EipConfigRequest​
No​
-​
The configurations related to automatically binding EIPs to nodes.​
Hostname​
String​
No​
test-name​
The hostname that corresponds to the node. It supports naming based on fixed increment and dynamic extension. For details on the relevant naming formats, see Naming formats.​
PreScript​
String​
No​
ZWNoby******​
The script to execute before node deployment. Enter the Base64-encoded shell script.​
tip​
Base64-encoded content can be up to 8 KB in length. If you specify both the InitializeScript and PreScript parameters, the total length of the two parameter values cannot exceed 8 KB.​
InstanceName​
String​
No​
instance-test​
The node (instance) name. The following two naming formats are supported: fixed growth sorting and dynamic expansion sorting. For details on the relevant naming format, see Naming formats.​
CpuMaxFrequency​
Double​
No​
2.875​
The maximum CPU frequency of the node.​
  • The value can have up to three decimal places and must be between the base CPU frequency and the turbo CPU frequency.​
  • The unit is GHz.​
NetworkTrafficMode​
String​
No​
Standard​
The network communication mode between nodes. Valid values:​
  • HighPerformance: A communication method for data transmission based on RDMA.​
  • Standard: A communication method for data transmission based on TCP.​
SpotStrategy​
String​
No​
SpotWithPriceLimit​
The preemptive​ instance strategy for pay-as-you-go billing. This parameter is valid only when InstanceChargeType is PostPaid. Valid values:​
  • NoSpot: Regular pay-as-you-go billing.​
  • SpotAsPriceGo: The system automatically bids, following the current market price.​
  • SpotWithPriceLimit: Sets a maximum price by instance specification.​
GpuDriverConfig​
Object of GpuDriverConfig​
No​
-​
GPU driver configuration for the node. This configuration takes precedence over the GpuDriverVersion field.​
tip​
If this parameter is not configured and the ECS instance in the node pool uses a GPU-type model, the system automatically sets InstallGpuDriver to true and populates the recommended GPU driver version.​
SpotPriceLimits​
No​
-​
The maximum price for spot instances.​
  • This parameter takes effect only when SpotStrategy is set to SpotWithPriceLimit.​
  • The value is an array in which each item specifies an instance specification and its maximum price in CNY/hour.​
GpuDriverVersion​
String​
No​
550.127.05​
[This parameter is deprecated. Use GpuDriverConfig instead.] Specifies the GPU driver version to be installed on the node.​
You can call the ListSupportedGpuDriverVersions API to obtain the list of GPU driver versions that can be installed for an image.​
InstanceChargeType​
String​
No​
PostPaid​
The billing type of ECS instances that correspond to nodes in the node pool. Valid values:​
  • PostPaid: Pay-as-you-go​
  • PrePaid: Subscription​
  • You need to take note of the following items when you switch between the two billing types:​
  • You can change the billing type from subscription to pay-as-you-go for a node pool.​
  • You can change the billing type from pay-as-you-go to subscription for a node pool when the following conditions are met:​
  • The preemption policy is not enabled, which means that SpotStrategy is NoSpot.​
  • The autoscaler is not enabled, which means that AutoScaling·Enabled is false.​
  • The elastic scheduled scale-out rule is not enabled, which means that when the ListScalingPolicies API is called, the query result is empty, or is not empty but Enabled is false.​
warning​
  • When you change the billing type of the node pool from pay-as-you-go to subscription, you need to specify the following three parameters: Period, AutoRenew, and AutoRenewPeriod.​
  • After you update the billing type of nodes in the node pool, this configuration only takes effect on newly added nodes. For existing nodes, go to the ECS console to manually modify their configurations.​
AffinityGroupConfig​
Object of AffinityGroupConfig​
No​
-​
[Beta - apply for trial] Affinity group configuration for the node pool.​
warning​
To use this feature, you need to obtain beta access to both the VKE feature and ‌the ECS affinity group capabilities‌. Consult your Volcano Engine account manager for details.​
​
SystemVolume​
​
Parameter​
Type​
Required​
Sample value​
Description​
Type​
String​
No​
ESSD_PL0​
The cloud disk type. Valid values:​
  • ESSD_PL0: ESSD of the PL0 specification.​
  • ESSD_FlexPL: ESSD of the FlexPL specification.​
  • Ultra_Disk: Ultra disk.​
  • TSSD_TL0: Throughput SSD of the TL0 specification.​
warning​
[Beta]: The ultra disk SSD (Ultra_Disk) is a beta feature of EBS and is available only in specific regions and for ECS instances. To use this feature, contact your account manager.​
Size​
Integer​
No​
40​
Cloud disk capacity. Unit: GiB. Valid values: 40 to 2048.​
BurstEnabled​
Boolean​
No​
true​
Whether to enable performance bursting. Valid values:​
  • true: Enabled.​
  • false: Disable it.​
tip​
  • This parameter is supported only when the cloud disk type is ESSD_FlexPL. For more information, see ESSD FlexPL cloud disks.​
SubgroupNumber​
Integer​
No​
2​
The number of the storage placement sub-group to which the system volume belongs.​
You can call the DescribePlacementGroupDetails API to obtain the number of the placement sub-group.​
PlacementGroupId​
String​
No​
pg-bp67*******​
The ID of the storage placement group to which the system volume belongs.​
You can call the DescribePlacementGroupDetails API to obtain the placement group ID.​
ExtraPerformanceIops​
Integer​
No​
10​
The IOPS of extra performance for the cloud disk. This parameter takes effect only when ExtraPerformanceTypeId is IOPS or Balance. The value is an integer within the range of 1 to 50000 and represents operations per second.​
ExtraPerformanceTypeId​
String​
No​
Bal****​
Extra performance type.​
  • This parameter can be configured only if the cloud disk specification is ESSD_FlexPL. Values:​
  • Balance: The balance type.​
  • IOPS: The IOPS type.​
  • Throughput: The throughput type.​
  • This parameter can be configured only if the cloud disk specification is TSSD_TL0. Values:​
  • Throughput: The throughput type.​
ExtraPerformanceThroughputMb​
Integer​
No​
10​
The throughput of the extra performance configuration for the cloud disk. This parameter takes effect only if ExtraPerformanceTypeId is Throughput. The value is an integer. Unit: MB/s.​
  • When the cloud disk specification is ESSD_FlexPL, the value range is 1 to 650. For more details, see ESSD FlexPL cloud disks.​
  • When the cloud disk specification is TSSD_TL0, the details are as follows: ​
  • The value range is related to the cloud disk capacity. The throughput performance is calculated through the following formula: min {120 + 0.5 × Capacity (GiB), 1000}, and the value cannot exceed the maximum throughput (1000 MB/s) of the cloud disk. For more details, see Throughput SSD cloud disks.​
  • For example, when the cloud disk capacity is 500 GiB, the base throughput is 370 MB/s, which is the calculation result of 120 + 0.5 × 500. In this case, the allowed range of extra performance is 1 to 630.​
  • For example, when the cloud disk capacity is 2,000 GiB, the base throughput is 1,120 MB/s, which is the calculation result of 120 + 0.5 × 2,000. In this case, the maximum allowed throughput has been exceeded. Therefore, extra performance cannot be configured.​
​
DataVolume​
​
Parameter​
Type​
Required​
Sample value​
Description​
Type​
String​
No​
ESSD_PL0​
The disk type. The cloud disk and local disk are supported.​
  • Cloud disks:​
  • ESSD_PL0: ESSD of the PL0 specification.​
  • ESSD_FlexPL: ESSD of the FlexPL specification.​
  • Ultra_Disk: Ultra disk.​
  • TSSD_TL0: Throughput SSD of the TL0 specification.​
  • RSSD_PL0: Remote elastic disk of the PL0 specification.​
  • Local disks:​
  • LOCAL_SSD: Local SSD.​
  • LOCAL_HDD: Local HDD.​
  • LOCAL_LVM_SSD: Local LVM-managed SSD.​
  • LOCAL_SSD_SRIOV: Local SSD SRIOV​
warning​
  • [Beta]: Remote elastic disks (RSSD_PL0) and Ultra disks (Ultra_Disk) are EBS beta features. They are available only in some regions and for some ECS instances. To request feature access, contact your account manager.​
  • When you configure local disks:​
  • Local disks are provided along with ECS instances. When you specify a local disk type, no additional local disk will be created.​
  • Confirm the local disk types that are supported by the instance specification configured for the node pool. For details, see Local disks.​
  • The number of local disks configured in the node pool cannot exceed that of those mounted to the ECS instances. You can call the DescribeInstanceTypes API to query the number of local disks mounted to instances.​
Size​
Integer​
No​
20​
The disk capacity. Unit: GiB. Valid values:​
  • For ESSD (ESSD_PL0 or ESSD_FlexPL), the value range is 20 to 32768.​
  • For ultra disks (Ultra_Disk), the value range is 20 to 32768.​
  • For throughput SSD (TSSD_TL0), the value range is 40 to 32768.​
  • For remote elastic disks (RSSD_PL0), the value range is 256 to 16384.​
MountPoint​
String​
No​
/vke​
The target mount directory after disk formatting. The value must meet the following requirements:​
  • It must start with a slash (/).​
  • It must be 1 to 255 characters in length.​
  • The mount directory for each data volume must be unique.​
FileSystem​
String​
No​
Ext4​
[Beta - apply for trial] The file system of the node pool data volume. Valid values:​
  • Ext4​
  • Xfs​
SnapshotId​
String​
No​
snap-31ak********​
The ID of the snapshot that is used for creating the data volume. You can call the DescribeSnapshots API to query the snapshot ID.​
tip​
  • Only the ESSD and ultra disk types support the creation of cloud disks through snapshots.​
  • Only snapshots in one of the following states support creating cloud disks:​
  • available​
  • creating​
  • rollbacking​
KmsKeyId​
String​
No​
e91b2a39-72********​
The ID of the KMS key used to encrypt the data volume. This parameter takes effect only when Encrypted is set to true.​
  • If this parameter is not specified or is empty, the default key is used.​
  • This parameter is required when you use a custom key. In this case, you need to specify the KMS key ID for encryption.​
Encrypted​
Boolean​
No​
true​
Whether to enable the data volume encryption feature. Valid values:​
  • true: Enable data volume encryption. After this feature is enabled, files on the data disk are stored in encrypted form. This prevents unauthorized access at the storage layer and helps meet data security compliance requirements.​
  • false: Disables data volume encryption.​
BurstEnabled​
Boolean​
No​
true​
Whether to enable performance bursting. Valid values:​
  • true: Enabled.​
  • false: Disable it.​
tip​
  • This parameter is supported only when the cloud disk type is ESSD_FlexPL. For more information, see ESSD FlexPL cloud disks.​
SubgroupNumber​
Integer​
No​
2​
The number of the storage placement sub-group to which the data volume belongs.​
You can call the DescribePlacementGroupDetails API to query the number of the storage placement sub-group.​
PlacementGroupId​
String​
No​
pg-bp67a********​
The number of the storage placement group to which the data volume belongs.​
You can call the DescribePlacementGroups API to query the storage placement group ID.​
ExtraPerformanceIops​
Integer​
No​
10​
The IOPS of extra performance for the cloud disk. This parameter takes effect only when ExtraPerformanceTypeId is IOPS or Balance. The value is an integer within the range of 1 to 50000 and represents operations per second.​
ExtraPerformanceTypeId​
String​
No​
Bal****​
Extra performance type.​
  • This parameter can be configured only if the cloud disk specification is ESSD_FlexPL. Values:​
  • Balance: The balance type.​
  • IOPS: The IOPS type.​
  • Throughput: The throughput type.​
  • This parameter can be configured only if the cloud disk specification is TSSD_TL0. Values:​
  • Throughput: The throughput type.​
ExtraPerformanceThroughputMb​
Integer​
No​
10​
The throughput of the extra performance configuration for the cloud disk. This parameter takes effect only if ExtraPerformanceTypeId is set to Throughput. The value is an integer. Unit: MB/s.​
  • When the cloud disk specification is ESSD_FlexPL, the value range is 1 to 650. For more details, see ESSD FlexPL cloud disks.​
  • When the cloud disk specification is TSSD_TL0, the details are as follows: ​
  • The value range is related to the cloud disk capacity. The throughput performance is calculated through the following formula: min {120 + 0.5 × Capacity (GiB), 1000}, and the value cannot exceed the maximum throughput (1000 MB/s) of the cloud disk. For more details, see Throughput SSD cloud disks.​
  • For example, when the cloud disk capacity is 500 GiB, the base throughput is 370 MB/s, which is the calculation result of 120 + 0.5 × 500. In this case, the allowed range of extra performance is 1 to 630.​
  • For example, when the cloud disk capacity is 2,000 GiB, the base throughput is 1,120 MB/s, which is the calculation result of 120 + 0.5 × 2,000. In this case, the maximum allowed throughput has been exceeded. Therefore, extra performance cannot be configured.​
​
NodeSecurityForUpdate​
​
Parameter​
Type​
Required​
Sample value​
Description​
Login​
Object of NodeLoginRequest​
No​
-​
The node access configurations.​
You can use a password or key pair. If both are provided, the key pair takes precedence.​
SecurityGroupIds​
Array of String​
No​
["sg-2byy13cns******"]​
The IDs of security groups where the node network is located.​
Call the DescribeSecurityGroups API of VPC to obtain the security group IDs. You can enter up to 100 security group IDs at a time.​
warning​
  • The security groups must be in the same VPC as the cluster.​
  • If this parameter is left empty, the default security group for cluster nodes is used. The name of the security group is in the format of <ClusterID>-common. For details about the default security group, see Security group settings.​
  • A single node pool can be associated with up to five security groups, including the default security group for nodes.​
SecurityStrategies​
Array of String​
No​
["Hids"]​
The security policy. Valid values:​
  • Hids: host-based intrusion detection system (HIDS)​
​
NodeLoginRequest​
​
Parameter​
Type​
Required​
Sample value​
Description​
Password​
String​
No​
UHdkM******​
The login password of the root user. The value must be Base64-encoded.​
The password must meet the following ECS instance password requirements:​
  • It must be 8 to 30 characters in length.​
  • It cannot start with / or $6$.​
  • It needs to contain at least three of the following character types:​
  • Lowercase letters a to z​
  • Uppercase letters A to Z​
  • Digits: 0 to 9​
  • Special characters: ( )~! @ # $ % ^ & * _ - + =​
SshKeyPairName​
String​
No​
test-key​
The name of the SSH key pair. Make sure that the key pair has been created or managed in ECS.​
​
Tag​
​
Parameter​
Type​
Required​
Sample value​
Description​
Key​
String​
Yes​
key​
The tag key.​
  • It cannot start with volc: in ‌any case variation‌.​
  • It can only contain letters, digits, spaces, and special characters _.:/=+-@.​
  • The length is limited to 1 to 128 characters.​
Value​
String​
No​
value​
The tag value, which can be left empty.​
  • It can only contain letters, digits, spaces, and the following special characters: _.:/=+-@.​
  • Its length does not exceed 256 characters.​
​
InstancesDistribution​
​
Parameter​
Type​
Required​
Sample value​
Description​
CapacityRebalance​
Boolean​
No​
false​
Specify whether to enable the feature to supplement preemptive​ instance capacity with pay-as-you-go instances. Valid values:​
  • true: Enabled. Before preemptive​ instances are reclaimed, new preemptive​ instances are proactively created for compensation.​
  • false: Disabled. A scale-out is performed to replenish the instance count only after the preemptive​ instance has been reclaimed.​
OnDemandBaseCapacity​
Integer​
No​
0​
The base capacity of pay-as-you-go instances. When the number of pay-as-you-go instances in the node pool is less than this value, pay-as-you-go instances will be preferentially created.​
The value range varies based on whether the node pool has the autoscaling feature enabled (i.e., AutoScaling·Enabled is set to true). The maximum value is 500. The details are as follows:​
  • When the autoscaler is not enabled, valid values are from 0 to the expected number of nodes in the node pool.​
  • When the autoscaler is enabled, valid values are from 0 to the minimum number of nodes configured for the autoscaler.​
CompensateWithOnDemand​
Boolean​
No​
false​
Specify whether to enable supplement of pay-as-you-go instances. Valid values:​
  • true: Enabled. When all preemptive instances fail to be purchased due to insufficient inventory or other reasons, the system attempts to purchase pay-as-you-go instances.​
  • false: Disabled. During scale-out, the system attempts to purchase configured preemptive​ instances only when they are required.​
OnDemandPercentageAboveBaseCapacity​
Integer​
No​
0​
Percentage of pay-as-you-go instances in the node pool. When you calculate the number of pay-as-you-go instances based on the percentage, you need to round up the value.​
  • Valid values: 0 to 100.​
  • Unit: %​
  • A value of 100 indicates that the node pool only consists of pay-as-you-go instances.​
​
EipConfigRequest​
​
Parameter​
Type​
Required​
Sample value​
Description​
Isp​
String​
No​
BGP​
The line type of the EIP. Valid values:​
  • BGP: BGP (multi-line)​
Bandwidth​
Integer​
No​
100​
The maximum bandwidth of the EIP. Unit: Mbit/s. Valid values:​
  • If BillingType is set to 2, the valid values of Bandwidth are 1 to 500.​
  • If BillingType is set to 3, the valid values of Bandwidth are 1 to 200.​
BillingType​
Integer​
No​
3​
The billing type of the EIP. Valid values:​
  • 3: Pay-as-you-go - usage-based billing. It charges based on the actual outbound Internet traffic, regardless of the duration.​
  • 2: Pay-as-you-go - by bandwidth limit. After you specify a maximum bandwidth, fees are calculated based on the usage duration, regardless of the actual traffic.​
BandwidthPackageId​
String​
No​
bwp-2zeo********​
The ID of the shared bandwidth package. The EIP address is added to the shared bandwidth package.​
You can call the DescribeBandwidthPackages API to query the ID of the shared bandwidth package.​
warning​
An EIP address can be added to a shared bandwidth package only when all of the following conditions are met:​
  • The line types are identical.​
  • The shared bandwidth package is of type IPv4.​
  • No security protection is configured for the shared bandwidth package.​
​
GpuDriverConfig​
​
Parameter​
Type​
Required​
Sample value​
Description​
GpuDriverVersion​
String​
No​
580.105.08​
Specifies the GPU driver version to be installed on the node.​
  • When the configuration is empty, the system automatically populates the recommended GPU driver version based on the GPU model.​
warning​
If you specify multiple ECS instance specifications in the node pool, the supported GPU drivers may vary with instance specifications. You need to specify a GPU driver supported by all instance specifications. Otherwise, an error will occur.​
InstallGpuDriver​
Boolean​
No​
true​
Specifies whether to automatically install the GPU driver when the node is a GPU-type ECS instance that uses a public base image (for example, veLinux 1.0 or Ubuntu 22.04). Valid values:​
  • true: Automatically installs the GPU driver. If you set the parameter to this value, you can use the GpuDriverVersion parameter to specify a GPU driver.​
  • false: Does not automatically install the GPU driver.​
tip​
When the ECS instance is a non-GPU model, this configuration does not take effect.​
​
InstanceTypeSpotPriceLimit​
​
Parameter​
Type​
Required​
Sample value​
Description​
InstanceTypeId​
String​
Yes​
ecs.g1i*******​
Instance specification ID. The specified instance specification must be included in the list of ECS instance specification IDs for the nodes. This applies even if the specification is specified by the InstanceTypeIds parameter.​
SpotPriceLimit​
Double​
Yes​
0.321​
The maximum price for spot instances of this instance specification. Unit: CNY/hour. Up to three decimal places are supported.​
​
AffinityGroupConfig​
​
Parameter​
Type​
Required​
Sample value​
Description​
Size​
Integer​
No​
2​
[Beta - apply for trial] Affinity group size used by the node pool. To query the affinity group size, call the DescribeInstanceTypes API.​
Enabled​
Boolean​
No​
false​
[Beta - apply for trial] Whether to enable affinity group configuration for the node pool. Valid values:​
  • true: Enables affinity group-based node purchases in the node pool.​
  • false: Disables affinity group configuration and uses standard node purchasing.​
​
NodePoolAutoScalingRequest​
​
Parameter​
Type​
Required​
Sample value​
Description​
Enabled​
Boolean​
No​
false​
Specify whether to enable the autoscaler feature for the node pool. Valid values:​
  • false: Disabled.​
  • true: Enabled.​
Priority​
Integer​
No​
10​
The priority level. Valid values: 0 to 100.​
warning​
This configuration takes effect only after autoscaling is enabled for the node pool and the scale-out algorithm is priority.​
MaxReplicas​
Integer​
No​
10​
The maximum number of nodes in the node pool. Valid values: 1 to 2000.​
warning​
This configuration takes effect only after the autoscaler feature is enabled for the node pool.​
MinReplicas​
Integer​
No​
0​
Specify the minimum number of nodes in the node pool. Valid values:​
  • Minimum value: 0​
  • Maximum value: The maximum value is less than the value of the MaxReplicas parameter.​
warning​
This configuration takes effect only after the autoscaler feature is enabled for the node pool.​
SubnetPolicy​
String​
No​
ZoneBalance​
The scheduling policy for multiple subnets of the node pool. Worker nodes are scheduled based on the subnet priority during scale-out. Valid values:​
  • ZoneBalance: Balancing across availability zones. For a node scale-out, new nodes are distributed across subnets in multiple availability zones to ensure a relatively balanced number of nodes in each availability zone.​
  • Priority: Subnet priority-based scheduling. Scheduling is performed according to the order of the subnets in the list. If the highest-priority subnet is available for successful creation, new nodes will always be added to that subnet.​
DesiredReplicas​
Integer​
No​
0​
The expected number of nodes in the node pool. Valid values: 0 to 2000.​
warning​
When you enable the autoscaler feature for the node pool, the value of the DesiredReplicas parameter must be greater than or equal to the value of the MinReplicas parameter, and must be less than or equal to the value of the MaxReplicas parameter.​
​
NodePoolManagementRequest​
​
Parameter​
Type​
Required​
Sample value​
Description​
Enabled​
Boolean​
No​
false​
Specify whether to enable the managed mode for the node pool. Valid values:​
  • true: Enabled.​
  • false: Disable it.​
tip​
After you enable the managed mode for the node pool, the cloud assistant Agent will be installed for newly added instances by default.​
RemedyConfig​
Object of RemedyConfigRequest​
No​
-​
The check and self-healing rule configuration of the node pool.​
​
RemedyConfigRequest​
​
Parameter​
Type​
Required​
Sample value​
Description​
Enabled​
Boolean​
No​
false​
Specify whether to enable node check and self-healing after you enable the managed mode for the node pool. Valid values:​
  • true: Enabled.​
  • false: Disable it.​
Id​
String​
No​
R2025091********​
The ID of the node self-healing rule to be associated after you enable check and self-healing for the node pool. If you do not specify this parameter, the node pool will automatically create and bind the rule.​
View the self-healing rule ID on the Health check & auto recovery page of the target cluster in the VKE console.​
​
Sample requests​
​
POST https://vke.cn-beijing.volcengineapi.com?Action=UpdateNodePoolConfig&Version=2022-05-12​
Content-Type: application/json​
{​
"ClientToken": "BC028527-33B9-4990-A633-84E9F9******",​
"ClusterId": "cc5silu*******",​
"Id": "pc51i0*******",​
"Name": "test-nodepool",​
"KubernetesConfig": {​
"Labels": [​
{​
"Key": "label-key",​
"Value": "label-value"​
}​
],​
"Taints": [​
{​
"Key": "taint-key",​
"Value": "taint-value",​
"Effect": "NoSchedule"​
}​
],​
"Cordon": false,​
"NamePrefix": "name-prefix",​
"NameSuffix": "-demo",​
"NameUseHostname": true,​
"AutoSyncDisabled": false​
},​
"NodeConfig": {​
"InstanceTypeIds": [​
"ecs.**.**"​
],​
"SubnetIds": [​
"subnet-3rf6wbg******"​
],​
"SystemVolume": {​
"Type": "ESSD_PL0",​
"Size": 40​
},​
"DataVolumes": [​
{​
"Type": "ESSD_PL0",​
"Size": 20,​
"FileSystem": "Ext4",​
"MountPoint": "/vke"​
}​
],​
"AdditionalContainerStorageEnabled": false,​
"InitializeScript": "ZWNoby******",​
"Security": {​
"SecurityGroupIds": [​
"sg-2byy13cn******"​
],​
"SecurityStrategies": [​
"Hids"​
],​
"Login": {​
"Password": "UHdkM******",​
"SshKeyPairName": "test-key"​
}​
},​
"Period": 12,​
"AutoRenew": true,​
"AutoRenewPeriod": 1,​
"NamePrefix": "prefix-name",​
"Tags": [​
{​
"Key": "key",​
"Value": "value"​
}​
],​
"HpcClusterIds": [​
"hpcCluster-1"​
],​
"ImageId": "image-kd********",​
"ProjectName": "default",​
"PublicAccessEnabled": false,​
"PublicAccessConfig": {​
"Isp": "BGP",​
"Bandwidth": 100,​
"BillingType": 3​
},​
"Hostname": "test-name",​
"PreScript": "ZWNoby******",​
"InstanceName": "instance-test",​
"NetworkTrafficMode": "Standard",​
"GpuDriverConfig": {​
"GpuDriverVersion": "580.105.08",​
"InstallGpuDriver": true​
},​
"InstancesDistribution": {​
"CapacityRebalance": false,​
"OnDemandBaseCapacity": 0,​
"CompensateWithOnDemand": false,​
"OnDemandPercentageAboveBaseCapacity": 0​
}​
},​
"AutoScaling": {​
"Enabled": false,​
"Priority": 10,​
"MaxReplicas": 10,​
"MinReplicas": 0,​
"SubnetPolicy": "ZoneBalance",​
"DesiredReplicas": 0​
},​
"Management": {​
"Enabled": false,​
"RemedyConfig": {​
"Id": "R2025091********",​
"Enabled": false​
}​
}​
}​
​
Response parameter​
This API has no API-specific response parameters. For details about common response parameters, see Response results.​
Sample responses​
​
HTTP/1.1 200 OK​
Content-Type:application/json​
​
{​
"ResponseMetadata": {​
"RequestId": "021635330********",​
"Action": "UpdateNodePoolConfig",​
"Version": "2022-05-12",​
"Service": "vke",​
"Region": "cn-beijing"​
},​
"Result": {}​
}​
​
Error code​
The error codes for this API are listed in the table below. For public error codes, see Public error codes.​
​
HTTP status code​
Error code​
Error message​
Description​
409​
Conflict.Name​
The specified name conflicts with existing {{resourceType}}.​
A resource with the same name exists in the specified region. Update the resource name and try again.​
400​
OperationDenied.ClusterStatus​
The action is forbidden due to cluster status {{statusPhase}} and {{statusConditions}}.​
The current status of the specified cluster does not support this operation. Confirm the required cluster status for this API and try again.​
400​
OperationDenied.NodePoolStatus​
The action is forbidden on node pool {{nodePoolId}} due to node pool status {{statusPhase}} and {{statusConditions}}.​
The current status of the specified node pool does not support this operation. Please confirm the required node pool status for this API and try again.​
400​
ClusterVpcMismatch.{{parameter}}​
The specified {{resourceType}} {{resourceId}} is not in the VPC of cluster.​
The specified subnets, security groups, and HPC cluster belong to different VPCs from the cluster. Make sure that they are in the same VPC as the cluster.​
400​
Mismatch.Replicas​
The specified DesiredReplicas, MinReplicas and MaxReplicas are mismatched.​
The specified minimum, maximum, and desired number of nodes​ in the node pool are logically inconsistent. Check the parameter and try again.​
400​
QuotaExceeded.Node​
The number of nodes in the cluster has reached the limit.​
The number of nodes in the current cluster has reached the limit. You can select another region or submit a ticket to apply for a quota increase.​
400​
LimitExceeded.NodeInCluster​
The number of nodes exceeds the cluster-defined pods config limit.​
The maximum nodes specified for the node pool exceeds the maximum nodes supported by the Flannel cluster. For limits on various resources of VKE, see Resource limits.​
The supported maximum nodes depend on PodsConfig.FlannelConfig.PodCidrs and MaxPodsPerNode. After a cluster is created, it cannot be modified. You need to plan cluster settings based on your business requirements.​
400​
UpdateNotAllowed.{{parameter}}​
The update to the specified parameter {{parameter}} is not allowed due to {{resourceType}}.​
The node pool cannot be updated.​
  • When the node pool is the default node pool, some properties, such as Name, AutoScaling, and NodeConfig, cannot be updated.​
  • When the node pool is a subscription node pool, the AutoScaling.Enabled property cannot be updated.​
  • When the node pool is a pay-as-you-go node pool, some properties, such as NodeConfig.Period, NodeConfig.AutoRenew, and NodeConfig.AutoRenewPeriod, cannot be updated.​
400​
LimitExceeded.MaximumVolumes​
You have reached the limit of the number of volumes that you can create.​
The number of cloud disks exceeds the maximum cloud disks that can be mounted to a single ECS instance. For the usage restrictions on ECS, see Constraints.​
400​
LimitExceeded.DataVolumeSize​
You have reached the limit of the size of data volume that you can create.​
The data volume capacity exceeds the upper limit. For ECS limits, see Limits.​
400​
LimitExceeded.SystemVolumeSize​
You have reached the limit of the size of the system volume that you can create.​
The system volume capacity exceeds the upper limit. For ECS limits, see Limits.​
400​
QuotaExceeded.{{ResourceType}}​
The quota of {{ResourceType}} has reached the limit.​
The quota for the specified resource has reached the upper limit, such as EIPs, ECS instances, ECS tags, and EBS. Increase the relevant resource quota or delete unused resources. When the available quota is sufficient, try again later.​
400​
ZoneMismatch.Subnet​
The specified Subnet {{subnetId}} is not in the cluster-defined zones.​
The availability zone to which the specified subnet belongs is not supported by the cluster. Use a subnet that is deployed in the availability zones of the cluster.​
400​
OutOfRange.DataVolumes​
There is no data volume for additional container storage enabling.​
The first data volume of the node is specified as the storage for container images and logs (namely, AdditionalContainerStorageEnabled=true), but no data volume has been specified in the DataVolume parameter. Specify the parameter and try again.​
400​
ZoneMismatch.InstanceType​
The specified InstanceType {{instanceType}} and subnet zones are mismatched.​
The availability zone of the subnet does not support the instance specification. Call the DescribeAvailableResource API of ECS to obtain the instance specifications supported in each availability zone. Then, update the parameters and try again.​
400​
InstanceTypeMismatch.VolumeType​
The specified VolumeType {{volumeType}} and InstanceType {{instanceType}} are mismatched.​
The specified instance specification and cloud disk specification do not match. Call the DescribeInstanceTypes API of ECS to obtain the matching relationship between ECS instance specifications and cloud disk specifications, update the parameter, and then try again.​
400​
NotSupported.{{parameter}}​
The specified {{resourceType}} {{resourceContent}} is not supported.​
The specified parameter (such as InstanceType or ImageId) is not supported. Check the parameter and try again.​
400​
ZoneMismatch.HpcCluster​
The specified HpcCluster {{hpcClusterID}} and subnet zones are mismatched.​
The specified availability zone of the HPC cluster does not match that of the node subnet. Make sure that both availability zones are consistent and try again.​
400​
ReplicasMismatch.OnDemandBaseCapacity​
The specified DesiredReplicas, MinReplicas and OnDemandBaseCapacity are mismatched.​
In the preemptive​ node pool, OnDemandBaseCapacity does not match DesiredReplicas and MinReplicas. Check the parameter and try again.​
400​
SpotStrategyMismatch.InstanceType​
The specified InstanceType {{instanceType}} and SpotStrategy {{spotStrategy}} are mismatched.​
The specified instance specification and preemption policy do not match. Specify the instance specification and try again.​
400​
Insufficient.Balance​
Your account has run out of balance.​
The balance of the current account is insufficient. Top up your account and try again.​
400​
InstanceTypeMismatch.ImageId​
The specified ImageId {{imageId}} and InstanceType {{instanceType}} are mismatched.​
The specified image ID (ImageId) does not match the ECS instance specification (InstanceTypeIds). Specify appropriate parameter values based on the parameter descriptions and try again.​
400​
ClusterVersionMismatch.ImageId​
The specified ImageId {{imageId}} and KubernetesVersion {{kubernetesVersion}} are mismatched.​
The specified image ID (ImageId) does not match the cluster Kubernetes version. Please specify a proper value according to the parameter description and try again later.​
400​
IpFamilyMismatch.{{parameter}}​
The specified {{resourceType}} {{resourceContent}} and IpFamily {{ipFamily}} are mismatched.​
The specified resources do not match the network protocol stack. Confirm the network protocol stack supported by the resources and try again.​
400​
LimitExceeded.LocalVolumes​
You have reached the limit of the number of local volumes that you can use.​
The quantity of local disks exceeds the limit. Specify appropriate parameter values based on the parameter descriptions and try again.​
400​
KubernetesVersionMismatch.{{parameter}}​
The specified config and kubernetes version are mismatched.​
The specified parameter does not match the Kubernetes version. Confirm the Kubernetes version supported by the parameter and try again.​
400​
ImageSizeMismatch.SystemVolumeSize​
The specified system volume size and image size are mismatched.​
The specified system volume size does not match the image size. The system volume must be at least 10 GiB larger than the image. Specify appropriate parameter values based on the parameter descriptions and try again.​
400​
SnapshotIdMismatch.DataVolumeType​
The specified data volume type {{volumeType}} and SnapshotId are mismatched.​
The specified data volume type does not match SnapshotId. Configure the correct parameter values based on the parameter description and try again.​
400​
SnapshotIdMismatch.DataVolumeSize​
The specified data volume size and data SnapshotId are mismatched.​
The disk size specified for the data volume must be greater than the cloud disk size that corresponds to SnapshotId.​
400​
PlacementGroupMismatch.SubgroupNumber​
The specified SubgroupNumber {{subgroupNumber}} and PlacementGroup {{placementGroupId}} are mismatched.​
The specified placement sub-group does not match the placement group. Specify appropriate parameter values based on the parameter descriptions and try again.​
400​
InstanceTypeMismatch.HpcCluster​
The specified HpcCluster {{hpcClusterID}} and InstanceType {{instanceType}} are mismatched.​
The specified high-performance cluster does not match the instance specification. Specify appropriate parameter values based on the parameter descriptions and try again.​
400​
Mismatch.InstanceTypeIds​
The specified InstanceTypeIds are mismatched.​
The ECS instance specifications do not match the corresponding node pool. You are not allowed to switch specifications between CPU and GPU types or across GPU manufacturers. Specify appropriate parameter values based on the parameter descriptions and try again.​
400​
DeploymentSetMismatch.InstanceType​
The specified InstanceType {{instanceType}} and DeploymentSet {{deploymentSetId}} are mismatched.​
The specified instance specification does not match the deployment set. Update the parameter and try again.​
400​
ZoneMismatch.VolumeType​
The specified volume type {{volumeType}} and subnet zones are mismatched.​
The specified cloud disk type does not match the availability zone of the subnet. Specify a cloud disk that matches the availability zone of the subnet and try again.​
400​
NetworkTrafficModeMismatch.InstanceType​
The specified InstanceType {{instanceType}} and NetworkTrafficMode {{networkTrafficMode}} are mismatched.​
The specified instance specification does not match the network communication mode. Specify appropriate parameter values based on the parameter descriptions and try again.​
400​
IpFamilyMismatch.PublicAccessEnabled​
The specified Config PublicAccessEnabled and cluster IpFamily {{ipFamily}} are mismatched.​
The cluster network stack does not match with automatic EIP binding for the nodes. Specify appropriate parameter values based on the parameter descriptions and try again.​
400​
InstanceChargeTypeMismatch.SpotStrategy​
The specified SpotStrategy {{spotStrategy}} and InstanceChargeType {{instanceChargeType}} are mismatched.​
The specified preemption policy and billing type do not match. Subscription node pools do not support preemption policies. Specify the parameter and try again.​
400​
InstanceChargeTypeMismatch.AutoScalingEnabled​
The specified AutoScalingEnabled and InstanceChargeType {{instanceChargeType}} are mismatched.​
The specified autoscaler switch and billing type do not match. You cannot enable the autoscaler for subscription node pools. Specify the parameters and try again.​
400​
NotSupportScalingPolicy.NodePoolConfig​
The specified nodepool config does not support scaling policy.​
The specified node pool configurations do not support scaling policies. Specify the parameter and try again.​
400​
KubernetesVersionMismatch.RuntimeVersion​
The specified runtime version {{runtimeVersion}} and Kubernetes version {{kubernetesVersion}} are mismatched.​
The specified container runtime version does not match the cluster Kubernetes version. For example, containerd 2.1.x is only supported in clusters with Kubernetes v1.34 or later. Specify another container runtime version and try again later. For more information, see the containerd release notes.​
400​
LimitExceeded.ScriptLength​
The InitializeScript and PreScript total length exceeds maximum allowed length.​
The total length of the pre-script and post-script exceeds the limit. Please specify a proper value according to the parameter description and try again later.​
400​
PublicAccessConfigMismatch.BandwidthPackageId​
The specified BandwidthPackage {{bandwidthPackageId}} does not match the PublicAccessConfig.​
The specified shared bandwidth package does not match the public access configuration. Specify appropriate parameter values based on the parameter descriptions and try again.​
400​
UnsupportedVolumeType.BurstEnabled​
The specified VolumeType {{volumeType}} does not support BurstEnabled.​
The specified cloud disk type does not support performance bursting. Change the cloud disk type and try again later.​
400​
UnsupportedInstanceChargeType.BurstEnabled​
The specified InstanceChargeType {{instanceChargeType}} does not support BurstEnabled.​
The specified instance billing type does not support performance bursting. Change the cloud disk billing type and try again later. For details, see Burst performance billing - ESSD FlexPL cloud disks.​
​
Last updated: 2026.10.10 17:41:57