Query the list and details of nodes that meet the specified conditions.

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 based on the region where your business is located.

Request method: POST

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

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	ListNodes	The API name. The name of the current API is ListNodes.
Version	String	Yes	May 12, 2022	The API version. The API version is 2022-05-12.
Filter	Object of ListNodesFilter	No	-	Node filter.
PageNumber	Integer	No	1	The starting page number for paginated queries. The value starts at 1 and defaults to 1.
PageSize	Integer	No	10	The number of results per page: Minimum value: 1 Maximum value: 100 Default value: 10

ListNodesFilter

Parameter	Type	Required	Sample value	Description
ClusterIds	Array of String	No	["cc5silumrsfeqxxxx"]	A list of cluster IDs. You can call the ListClusters API to obtain cluster IDs. Up to 100 cluster IDs can be included in a single query. tip If this parameter is an empty array, filtering is performed based on all clusters in the specified region within the account.
Ids	Array of String	No	["nc5t5epmrsfxxxx"]	A list of node IDs. At most 100 node IDs can be specified per call.
Name	String	No	test-node	Node name. Fuzzy matching is supported.
NodePoolIds	Array of String	No	["pc8oah9cbcvxxxx"]	A list of node pool IDs. You can call the ListNodePools API to obtain node pool IDs. At most 100 node pool IDs can be specified per call.
ZoneIds	Array of String	No	["cn-beijing-a"]	A list of availability zone IDs. For a complete list of VKE availability zones, see Regions and availability zones.
Statuses	Array of NodeStatusFilter	No	-	Node status. At most 15 array elements can be specified per call. The logic OR is applied to represent relations among multiple statuses.
CreateClientToken	String	No	BusinessRequest12345	The ClientToken generated upon successful creation. 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.
InstanceIds	Array of String	No	["i-yd329xxxx"]	The ID of the ECS instance corresponding to the node. Exact matching is required. You can call the DescribeInstances API to obtain the ECS instance ID of the node. Up to 100 ECS instance IDs can be specified per call.
MetadataName	String	No	192.168.*.*	Filter by node metadata name. Fuzzy matching is supported.
AffinityGroupIds	Array of String	No	["agp-xxxx"]	[Beta - apply for trial] Filter by affinity group ID for precise querying. warning To use affinity group-related capabilities of node pools, 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. You can call the DescribeInstances API to obtain the affinity group ID.

NodeStatusFilter

Parameter	Type	Required	Sample value	Description
Phase	String	No	Running	Node status. Valid values: Creating: It is being created. Running: It is running. Deleting: It is being deleted. Failed: An abnormality has occurred. Updating: It is being updated. tip At least one of Phase and Conditions.Type must be provided. Otherwise, it is an invalid array element. For valid combinations of Phase and Conditions.Type, see Resource status description.
Conditions.Type	String	No	Ok	The condition under which the node enters the primary status. You can specify multiple conditions. Valid values: Progressing: The processing is in progress. Ok: The status is normal. Unschedulable: It is unschedulable. InitilizeFailed: Initialization failed. NotReady: It is abnormal. Balance: The account is in arrears. ResourceCleanupFailed: Removal of linked resources failed. Unknown: An unknown error occurs. ClusterVersionUpgrading: The node version is being upgraded. tip At least one of Phase and Conditions.Type must be provided. Otherwise, it is an invalid array element. For valid combinations of Phase and Conditions.Type, see Resource status description.

Sample requests

Response parameter

The following table contains the response parameters of this API. See Response results for details about public response parameters.

Parameter	Type	Sample value	Description
Items	Array of Node	-	A list of nodes.
PageNumber	Integer	1	The current page number.
PageSize	Integer	10	Number of nodes displayed per page.
TotalCount	Integer	100	Total number of nodes that meet the conditions.

Node

Parameter	Type	Sample value	Description
Id	String	nc5t5ep********	Node ID.
Name	String	test-node	Node name.
ClusterId	String	cc5silum********	Cluster ID.
InstanceId	String	i-ybo922********	ID of the ECS instance corresponding to the node.
NodePoolId	String	pc8oah9********	The node pool ID.
ZoneId	String	cn-bei******	Availability zone ID.
Roles	Array of String	["Worker"]	Node role. Valid values: Worker: Worker node
CreateClientToken	String	BusinessRequest12345	The ClientToken generated upon successful creation. The ClientToken is a string that ensures request idempotency. This string is provided by the caller.
CreateTime	String	2021-10-27T10:33:30Z	The creation time. UTC+0 time in standard RFC3339 format.
UpdateTime	String	2021-10-29T10:33:30Z	Update time. UTC+0 time in standard RFC3339 format.
Status	Object of NodeStatus	-	Node status.
IsVirtual	Boolean	false	Whether it is a virtual node. Values: false: No true: Yes
AdditionalContainerStorageEnabled	Boolean	false	Whether a data volume on the node has been configured as the storage directory for container images and logs. Valid values: false: No true: Yes
ContainerStoragePath	String	/dev/vdb	Device name of the data volume used as the storage directory for container images and logs.
ImageId	String	image-kd********	ID of the image used by the ECS instance corresponding to the node.
InitializeScript	String	ZWNob****	The script executed after creating the ECS node and deploying Kubernetes components.
KubernetesConfig	Object of KubernetesConfigResponse	-	Kubernetes-related configuration used during node initialization. tip Labels and taints added after node creation will not be returned by this OpenAPI call. To obtain them, connect to the cluster and use the Kubernetes API. For information about the Kubernetes API, see the official documentation.
PreScript	String	ZWNob****	[Beta - apply for trial] Base64-encoded content of the script executed before deploying the node.[Beta - apply for trial]
MetadataName	String	192.168.*.*	Metadata name of the node object in Kubernetes.
AffinityGroupId	String	affinityGro********	[Beta - apply for trial] The ID of the affinity group to which the node belongs.
GpuDriverVersion	String	550.1.1	GPU driver version.
ContainerStorageMountPoint	String	/mnt/vdb	The target mount directory after the data volume device is formatted.

NodeStatus

Parameter	Type	Sample value	Description
Phase	String	Running	Node status. Valid values: Creating: It is being created. Running: It is running. Deleting: It is being deleted. Failed: An abnormality has occurred. Updating: It is being updated. tip For valid combinations of Phase and Conditions.Type, see Resource status description.
Conditions	Array of NodeStatusCondition	-	The condition under which the node enters the primary status. tip For valid combinations of Phase and Conditions.Type, see Resource status description.

NodeStatusCondition

Parameter	Type	Sample value	Description
Type	String	Ok	The condition under which the node enters the primary status. You can specify multiple conditions. Valid values: Progressing: The processing is in progress. Ok: The status is normal. Unschedulable: It is unschedulable. InitilizeFailed: Initialization failed. NotReady: It is abnormal. Balance: The account is in arrears. ResourceCleanupFailed: Removal of linked resources failed. Unknown: An unknown error occurs. ClusterVersionUpgrading: The node version is being upgraded.

KubernetesConfigResponse

Parameter	Type	Sample value	Description
Labels	Array of Label	-	Kubernetes labels of the node pool or node.
Taints	Array of Taint	-	The Kubernetes taints of the node pool or the node.
Cordon	Boolean	false	Node cordon configuration switch. Value description: false: Disable node cordoning. true: Enable node cordoning.

Label

Parameter	Type	Sample value	Description
Key	String	label-key	The tag key.
Value	String	label-value	The label value.

Taint

Parameter	Type	Sample value	Description
Key	String	taint-key	The taint key.
Value	String	taint-value	The taint value.
Effect	String	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.

Sample responses

Error code

This API has no API-specific error codes. For details about common error codes, see Common error codes.

Volcengine Kubernetes Engine