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

查询升级任务详情 - ShowUpgradeTaskDetail

功能介绍

根据任务ID查询升级任务详情。

  • 包括定时配置、执行策略、灰度配置、应用对象等完整信息

调试

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

授权信息

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

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

    授权项

    访问级别

    资源类型（*为必须）

    条件键

    别名

    依赖的授权项

    workspace:upgradeTask:get

    Read

    -

    -

    -

    -

URI

GET /v2/{project_id}/upgrade-task/{task_id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID

task_id

是

String

任务ID

请求参数

无

响应参数

状态码：200

表2 响应Body参数

参数

参数类型

描述

id

String

任务ID

project_id

String

ID

task_name

String

任务名称

task_type

Integer

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

scheduled_type

String

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

timezone

String

时区

week_list

String

周期按周时：取值1~7，英文逗号分隔，如1,2,7

month_list

String

周期按月时：取值1~12，英文逗号分隔

date_list

String

周期按月时：取值1~31及L(代表当月最后一天)

day_interval

Integer

按天跳过天数

scheduled_date

String

周期指定时间时：表示指定的日期

scheduled_time

String

指定的执行时间点

cron_expression

String

Cron表达式

last_execute_status

String

最近执行状态：SUCCESS-成功 FAILED-失败 RUNNING-执行中 WAITING-等待

last_execute_time

String

最近执行时间

next_execute_time

String

下次执行时间

is_enable

Integer

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

is_force_execute

Integer

是否强制升级：0-否 1-是

min_version

String

低于此版本升级

target_version

String

升级目标版本

expire_enable

Integer

过期时间开启：0-未开启 1-开启

expire_time

String

过期时间

is_notify

Integer

是否通知：0-不通知 1-通知

extra_params

String

扩展参数（JSON格式）

execute_strategy

Integer

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

grayscale_rule

Integer

灰度规则：0-确定 1-随机（execute_strategy=1时使用）

gray_object_ids

String

灰度对象id列表

random_first_batch_count

Integer

随机首批执行数

gray_fail_threshold

Integer

首批执行失败阈值

scheduled_end_time

String

时间窗结束时间

description

String

任务描述

状态码：400

表3 响应Body参数

参数

参数类型

描述

error_code

String

业务错误码

error_msg

String

业务错误描述

状态码：500

表4 响应Body参数

参数

参数类型

描述

error_code

String

业务错误码

error_msg

String

业务错误描述

请求示例

无

响应示例

状态码：200

ok

{
  "id" : "task-001",
  "project_id" : "project-001",
  "task_name" : "每日桌面升级任务",
  "task_type" : 0,
  "scheduled_type" : "DAY",
  "timezone" : "Asia/Shanghai",
  "week_list" : "1,2,7",
  "month_list" : "1,6,12",
  "date_list" : "1,15,L",
  "day_interval" : 1,
  "scheduled_date" : "2026-05-01",
  "scheduled_time" : "02:00",
  "cron_expression" : "0 2 * * *",
  "last_execute_status" : "SUCCESS",
  "last_execute_time" : "2026-05-08T02:00:00Z",
  "next_execute_time" : "2026-05-09T02:00:00Z",
  "is_enable" : 1,
  "is_force_execute" : 1,
  "min_version" : "23.0.0",
  "target_version" : "24.6.3",
  "expire_enable" : 1,
  "expire_time" : "2026-12-31 23:59:59",
  "is_notify" : 1,
  "execute_strategy" : 0,
  "grayscale_rule" : 0,
  "random_first_batch_count" : 100,
  "gray_fail_threshold" : 10,
  "scheduled_end_time" : "12:00:00",
  "description" : "每日凌晨2点执行桌面升级",
  "extra_params" : "{}",
  "gray_object_ids" : "sid-001,sid-002,sid-003"
}

状态码

状态码

描述

200

ok

400

请求参数错误

500

服务器内部错误

错误码

请参见错误码。