文档首页/ 云桌面 Workspace/ API参考/ 云桌面API/ 升级任务管理服务/ 查询升级任务列表 - ListUpgradeTasks
更新时间：2026-07-24 GMT+08:00
查看PDF
分享

查询升级任务列表 - ListUpgradeTasks

功能介绍

分页查询升级任务列表。

  • 支持按任务名称（模糊）、任务类型、执行周期类型、启用状态、上次执行状态条件查询

  • 默认按创建时间倒序排序

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
  • 如果使用身份策略授权，需具备如下身份策略权限。

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    workspace:upgradeTask:list

    List

    -

    -

    -

    -

URI

GET /v2/{project_id}/upgrade-tasks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID
表2 Query参数

参数

是否必选

参数类型

描述

task_id

否

String

任务id

task_name

否

String

任务名称（支持模糊查询）

task_type

否

Integer

任务类型：0-云桌面 1-应用服务器 2-镜像

scheduled_type

否

String

执行周期类型：FIXED_TIME-指定时间 DAY-按天 WEEK-按周 MONTH-按月

is_enable

否

Integer

启用状态：0-未启用 1-启用

last_execute_status

否

String

上次执行状态

offset

否

Integer

偏移量，默认0

limit

否

Integer

每页数量，默认10，最大100

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

total

Integer

总数

tasks

Array of UpgradeScheduledTaskVO objects

任务列表
表4 UpgradeScheduledTaskVO

参数

参数类型

描述

id

String

任务ID

task_name

String

任务名称

task_type

Integer

任务类型：0-云桌面 1-应用服务器 2-镜像

scheduled_type

String

执行周期类型：FIXED_TIME-指定时间 DAY-按天 WEEK-按周 MONTH-按月

timezone

String

时区

last_execute_status

String

最近一次执行情况：SUCCESS-成功 FAILED-失败 RUNNING-执行中 WAITING-等待

next_execute_time

String

下次执行时间

is_enable

Integer

启用状态：0-未启用 1-启用

target_version

String

目标版本

execute_strategy

Integer

执行策略：0-全量下发 1-灰度下发

description

String

任务描述

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

业务错误码

error_msg

String

业务错误描述

状态码：500

表6 响应Body参数

参数

参数类型

描述

error_code

String

业务错误码

error_msg

String

业务错误描述

请求示例

无

响应示例

状态码：200

ok

{
  "total" : 100,
  "tasks" : [ {
    "id" : "task-001",
    "task_name" : "每日桌面升级任务",
    "task_type" : 0,
    "scheduled_type" : "DAY",
    "timezone" : "Asia/Shanghai",
    "last_execute_status" : "SUCCESS",
    "next_execute_time" : "2026-05-09T02:00:00Z",
    "is_enable" : 1,
    "target_version" : "24.6.3",
    "execute_strategy" : 0,
    "description" : "每日凌晨2点执行桌面升级"
  } ]
}

状态码

状态码

描述

200

ok

400

请求参数错误

500

服务器内部错误

错误码

请参见错误码。