Get a list of various tasks in the VKE cluster.

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=ListTasks&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	ListTasks	The API name. The current API name is ListTasks.
Version	String	Yes	2022-05-12	The API version. The current version of the API is 2022-05-12.
AccountId	Long	Yes	210******	Volcano Engine root user ID. Log in to the Volcano Engine console and obtain the account ID on the homepage.
Filter	Object of ListTasksFilter	No	-	Filter criteria for the upgrade task list to be queried.
PageNumber	Integer	No	1	The starting page number of the pagination query, starting from 1. Default value: 1.
PageSize	Integer	No	10	The number of results per page: Minimum value: 1 Maximum value: 100 Default value: 10

ListTasksFilter

Parameter	Type	Required	Sample value	Description
Ids	Array of String	No	["taskxj******"]	Task ID. When calling UpgradeNodePools or UpdateClusterVersion, the corresponding task ID will be returned.
Types	Array of String	No	["PrecheckDataPlane"]	Task type. Valid values: PrecheckDataPlane: Data plane upgrade precheck UpgradeDataPlane: Data plane upgrade PrechekControlPlane: Control plane upgrade precheck UpgradeControlPlane: Control plane upgrade
Groups	Array of String	No	["Cluster"]	Task group. Valid values: Cluster NodePool Node: Node
NodeIds	Array of String	No	["n-********"]	A list of node IDs. You can call the ListNodes API to obtain the node ID. At most 100 node IDs can be specified per call.
Sources	Array of String	No	["Plan"]	Task source. Valid values: Plan: Scheduled task Task: Instant task
Statuses	Array of TaskStatusFilter	No	-	Filter by task status.
ClusterIds	Array of String	No	["ccjkl******"]	Cluster ID. You can call the ListClusters API to obtain cluster IDs. A single call can include at most 100 cluster IDs.
NodePoolIds	Array of String	No	["phjh******"]	The node pool ID. You can call the ListNodePools API to obtain node pool IDs. At most 100 node pool IDs can be specified per call.

TaskStatusFilter

Parameter	Type	Required	Sample value	Description
Phase	String	No	Running	Task status. Values: Running: It is running. Succeeded: Succeeded Failed: Failed Aborted: Aborted Paused: Paused Pending: Pending Approving: Approving Waiting: Waiting to be executed

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 Task	-	Task details.
TotalCount	Integer	1	Total number of tasks.
PageNumber	Integer	1	The current page number.
PageSize	Integer	10	Number of tasks displayed per page.

Task

Parameter	Type	Sample value	Description
Type	String	PrecheckDataPlane	Task type. Valid values: PrecheckDataPlane: Data plane upgrade precheck UpgradeDataPlane: Data plane upgrade PrechekControlPlane: Control plane upgrade precheck UpgradeControlPlane: Control plane upgrade
Group	String	Cluster	Task group. Valid values: Cluster NodePool Node: Node
Steps	Array of TaskStepResponse	-	Task step information.
Source	String	Plan	Task source. Valid values: Plan: Scheduled task Task: Instant task
Status	Object of TaskStatusResponse	-	Task status.
Target	String	metrics-server	Change object, i.e., the resource on which the task acts.
TaskId	String	tcax******	Task ID.
EndTime	String	2026-08-27T07:36:56Z	Task end time. UTC+0 time in standard RFC3339 format.
ClusterId	String	chkjl*******	Cluster ID.
ExtraArgs	String	{"promoted":true}	Task extra parameters.
StartTime	String	2023-10-27T07:26:56Z	Task start time. UTC+0 time in standard RFC3339 format.
Exceptions	Array of TaskExceptionResponse	-	Task exception content.
NodePoolId	String	phj******	The node pool ID.
Parameters	String	{"accountID":210**,"clusterID":"cda7u**"}	Task metadata.
PlanStartTime	String	2024-10-27T07:36:56Z	The scheduled time for executing the task. UTC+0 time in standard RFC3339 format.

TaskStepResponse

Parameter	Type	Sample value	Description
Type	String	UpdateNodes	Task step type. Valid values: PrecheckControlPlane: Control plane upgrade precheck UpgradeControlPlane: Upgrade the control plane PostcheckControlPlane: Control plane upgrade postcheck PrecheckDataPlane: Data plane upgrade precheck UpgradeDataPlane: Upgrade the data plane PostcheckDataPlane: Data plane upgrade postcheck
Status	String	Running	Task step status. Valid values: Waiting: The task is waiting to be executed Running: The task is in progress Succeeded: The task executed successfully Failed: The task execution failed
EndTime	String	2023-10-27T07:26:56Z	Task step end time. UTC+0 time in standard RFC3339 format.
Message	String	precheck failed	Supplementary information for task steps.
StartTime	String	2023-10-27T07:26:56Z	Task step start time. UTC+0 time in standard RFC3339 format.

TaskStatusResponse

Parameter	Type	Sample value	Description
Phase	String	Running	Task status. Valid values: Running: It is running. Succeeded: Succeeded Failed: Failed Aborted: Aborted Paused: Paused Pending: Pending Approving: Approving Waiting: Waiting to be executed

TaskExceptionResponse

Parameter	Type	Sample value	Description
Message	String	Pod is still pending	Task exception information.
Resources	Array of TaskResourceResponse	-	List of abnormal resources.

TaskResourceResponse

Parameter	Type	Sample value	Description
Ids	Array of String	["nhj******"]	Abnormal resource ID.
Type	String	Node	Abnormal resource type.

Sample responses

Error code

There are no proprietary error codes for this API. See Public error codes for details about public error codes.

Volcengine Kubernetes Engine