Docs

Volcengine Kubernetes Engine

NodePool management

ScaleNodePool

Scale out the specified node pool.

tip

This OpenAPI interface can only scale out nodes in the specified node pool and does not support scaling in nodes. To scale in nodes, use the UpdateNodePoolConfig or DeleteNodes API.

Request description

VKE has deployed services in multiple regions globally to provide a stable and low-latency access experience. You can refer to the Service addresses topic and select the most suitable access point for your business region.

Request method: POST

Request URL: https://vke.cn-beijing.volcengineapi.com?Action=ScaleNodePool&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.

Go to debug

Request parameters

The following table describes the API request parameters. You also need to provide public parameters when calling this API. See Public parameters for details.

Parameter	Type	Required	Sample value	Description
Action	String	Yes	ScaleNodePool	The API name. The API name is ScaleNodePool.
Version	String	Yes	2022-05-12	The API version. The current version of the API is 2022-05-12.
ClusterId	String	Yes	cc5silu*******	The ID of the cluster where the node pool is located. Cluster IDs can be obtained by calling the ListClusters API. warning The cluster must be in the {Running,[Ok]} or {Updating,[Progressing]} state. You can call the ListClusters API to view 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.
Count	Integer	Yes	2	Number of nodes to scale out. The value must be an integer greater than 0. tip The maximum value of this parameter depends on the desired node count configuration for the node pool. The sum of the ‌desired node count (DesiredReplicas‌) and scale-out node count (‌Count‌) for a node pool must not exceed the maximum node count (2,000) of the node pool. When autoscaling is enabled for the node pool, the total node count after scaling must not exceed the ‌value of the MaxReplicas‌ parameter. For information about how to configure DesiredReplicas and MaxReplicas, see CreateNodePool.
ClientToken	String	No	BC028527-33***	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.

Sample requests

Response parameters

There are no proprietary response parameters for this API. See Response results for details about public response parameters.

Sample responses

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
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. Please 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	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}}.	Certain attributes of the specified object cannot be updated due to its resource type.
400	QuotaExceeded.{{ResourceType}}	The quota of {{ResourceType}} has reached the limit.	The quota for the specified resource (such as EIP or EBS) has reached its upper limit. Increase the relevant resource quota or delete unused resources. When the available quota is sufficient, try again later.
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.

Last updated: 2026.07.07 11:39:29