创建升级定时任务 - CreateUpgradeScheduleTask

功能介绍

创建升级任务，支持配置定时任务、执行策略、灰度策略、应用对象等。

任务名称在当前项目下唯一
创建后默认按配置的定时规则执行

调试

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

授权信息

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

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

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

workspace:upgradeTask:create

Write

-

-

-

-

授权项	访问级别	资源类型（*为必须）	条件键	别名	依赖的授权项
workspace:upgradeTask:create	Write	-	-	-	-

URI

POST /v2/{project_id}/upgrade-task

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	项目ID

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
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	指定的执行时间点
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时使用）
random_first_batch_count	否	Integer	随机首批执行数
gray_object_ids	否	String	灰度对象id列表（JSON数组格式）
gray_fail_threshold	否	Integer	首批执行失败阈值
scheduled_end_time	是	String	时间窗结束时间
is_enable	是	Integer	是否启用
description	否	String	任务描述
apply_objects	否	Array of TaskApplyObjectInfo objects	应用对象列表

表3 TaskApplyObjectInfo
参数	是否必选	参数类型	描述
object_type	是	String	应用对象类型，包括DESKTOP（单桌面）、ALL_DESKTOPS（全部桌面）、DESKTOP_POOL（桌面池）、DESKTOP_TAG（桌面标签）、ALL_USERS（全部用户）、USER（单个用户）、USER_GROUP（用户组）、ALL_IMAGES（全部镜像）、APPLICATION_SERVER（应用服务器）、APPLICATION_SERVER_GROUP（应用服务器组）
object_id	否	String	对象ID（object_type为ALL_DESKTOPS、ALL_USERS或ALL_IMAGES时可为null）

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
task_id	String	任务ID

状态码：400

表5 响应Body参数
参数	参数类型	描述
error_code	String	业务错误码
error_msg	String	业务错误描述

状态码：500

表6 响应Body参数
参数	参数类型	描述
error_code	String	业务错误码
error_msg	String	业务错误描述

请求示例

{
  "task_name" : "每日桌面升级任务",
  "task_type" : 0,
  "scheduled_type" : "DAY",
  "timezone" : "Asia/Shanghai",
  "scheduled_time" : "02:00",
  "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,
  "scheduled_end_time" : "12:00:00",
  "is_enable" : 1,
  "description" : "每日凌晨2点执行桌面升级",
  "apply_objects" : [ {
    "object_type" : "ALL_DESKTOPS",
    "object_id" : null
  } ]
}