获取 VKE 集群中各类任务列表。

请求说明

VKE 已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地域，选择最合适的接入点。

请求地址：https://vke.cn-beijing.volcengineapi.com?Action=ListTasks&Version=2022-05-12

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

请求参数

调用该 API 时的请求参数如下，除此之外还需传入公共请求参数。公共请求参数说明，请参见公共参数。

参数	类型	是否必选	示例值	描述
Action	String	是	ListTasks	接口名称。当前 API 的名称为 ListTasks。
Version	String	是	2022-05-12	接口版本。当前 API 的版本为 2022-05-12。
AccountId	Long	是	210******	火山引擎账号 ID。登录火山引擎控制台，在首页获取账号 ID。
Filter	Object of ListTasksFilter	否	-	待查询的升级任务列表过滤条件。
PageNumber	Integer	否	1	分页查询时的起始页码，从 1 开始，默认为 1。
PageSize	Integer	否	10	分页查询时每页显示的记录数，取值：最小值：1 最大值：100 默认值：10

ListTasksFilter

参数	类型	是否必选	示例值	描述
Ids	Array of String	否	["taskxj******"]	任务 ID。调用 UpgradeNodePools、UpdateClusterVersion 时会返回对应的任务 ID。
Types	Array of String	否	["PrecheckDataPlane"]	任务类型。取值： PrecheckDataPlane：数据面升级检查 UpgradeDataPlane：数据面升级 PrechekControlPlane：控制面升级预检 UpgradeControlPlane：控制面升级
Groups	Array of String	否	["Cluster"]	任务分组。取值： Cluster：集群 NodePool：节点池 Node：节点
NodeIds	Array of String	否	["n-********"]	节点 ID 列表。可调用 ListNodes 接口，获取节点 ID。单次调用最多填写 100 个节点 ID。
Sources	Array of String	否	["Plan"]	任务来源。取值： Plan：预约任务 Task：即时任务
Statuses	Array of TaskStatusFilter	否	-	按任务状态进行过滤。
ClusterIds	Array of String	否	["ccjkl******"]	集群的 ID。可以调用 ListClusters 接口，获取集群 ID。单次调用最多填写 100 个集群 ID。
NodePoolIds	Array of String	否	["phjh******"]	节点池 ID。可以调用 ListNodePools 接口，获取节点池 ID。单次调用最多填写 100 个节点池 ID。

TaskStatusFilter

参数	类型	是否必选	示例值	描述
Phase	String	否	Running	任务状态。取值: Running：运行中 Succeeded：已成功 Failed：已失败 Aborted：已中止 Paused：已暂停 Pending：等待中 Approving：审批中 Waiting：待执行

请求示例

返回参数

本接口返回参数如下表所示，公共返回参数请参见返回结果。

Task

参数	类型	示例值	描述
Type	String	PrecheckDataPlane	任务类型。参数值说明： PrecheckDataPlane：数据面升级检查 UpgradeDataPlane：数据面升级 PrechekControlPlane：控制面升级预检 UpgradeControlPlane：控制面升级
Group	String	Cluster	任务分组。参数值说明： Cluster：集群 NodePool：节点池 Node：节点
Steps	Array of TaskStepResponse	-	任务步骤信息。
Source	String	Plan	任务来源。参数值说明： Plan：预约任务 Task：即时任务
Status	Object of TaskStatusResponse	-	任务状态。
Target	String	metrics-server	变更对象，即任务作用的资源。
TaskId	String	tcax******	任务 ID。
EndTime	String	2026-08-27T07:36:56Z	任务结束时间。标准 RFC3339 格式的 UTC+0 时间。
ClusterId	String	chkjl*******	集群 ID。
ExtraArgs	String	{"promoted":true}	任务额外参数。
StartTime	String	2023-10-27T07:26:56Z	任务开始时间。标准 RFC3339 格式的 UTC+0 时间。
Exceptions	Array of TaskExceptionResponse	-	任务异常内容。
NodePoolId	String	phj******	节点池 ID。
Parameters	String	{"accountID":210**,"clusterID":"cda7u**"}	任务元数据。
PlanStartTime	String	2024-10-27T07:36:56Z	计划执行任务的时间。标准 RFC3339 格式的 UTC+0 时间。

TaskStepResponse

参数	类型	示例值	描述
Type	String	UpdateNodes	任务步骤类型。参数值说明： PrecheckControlPlane：控制面升级前置检查 UpgradeControlPlane：升级控制面 PostcheckControlPlane：控制面升级后置检查 PrecheckDataPlane：数据面升级前置检查 UpgradeDataPlane：升级数据面 PostcheckDataPlane：数据面升级后置检查
Status	String	Running	任务步骤状态。参数值说明： Waiting：任务等待执行 Running：任务进行中 Succeeded：任务执行成功 Failed：任务执行失败
EndTime	String	2023-10-27T07:26:56Z	任务步骤结束时间。标准 RFC3339 格式的 UTC+0 时间。
Message	String	precheck failed	任务步骤补充信息。
StartTime	String	2023-10-27T07:26:56Z	任务步骤开始时间。标准 RFC3339 格式的 UTC+0 时间。

TaskStatusResponse

参数	类型	示例值	描述
Phase	String	Running	任务状态。参数值说明： Running：运行中 Succeeded：已成功 Failed：已失败 Aborted：已中止 Paused：已暂停 Pending：等待中 Approving：审批中 Waiting：待执行

TaskExceptionResponse

参数	类型	示例值	描述
Message	String	Pod is still pending	任务异常信息。
Resources	Array of TaskResourceResponse	-	异常资源列表。

TaskResourceResponse

返回示例

错误码

本接口无专有错误码，公共错误码请参见公共错误码。