触发升级任务 - ExecuteTriggerUpgrade

功能介绍

根据配置参数触发桌面升级任务。

支持强制升级、版本指定、超时控制及通知功能
触发后立即执行，不受定时任务调度

调试

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

授权信息

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

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

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

workspace:upgradeTask:execute

Write

-

-

-

-

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

URI

POST /v2/{project_id}/upgrade-task/execute

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

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
is_force_execute	是	Integer	是否强制升级：0-否 1-是
target_version	是	String	升级目标版本
description	否	String	升级任务描述
is_notify	是	Integer	通知开启：0-未开启 1-开启
extra_params	否	String	扩展参数（JSON格式）
desktop_sids	否	Array of strings	桌面sids列表

响应参数

状态码：200

状态码：400

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

状态码：500

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

请求示例

{
  "is_force_execute" : 1,
  "target_version" : "24.6.3",
  "is_notify" : 1,
  "extra_params" : "{}",
  "desktop_sids" : [ "sid-001", "sid-002", "sid-003" ]
}