Triggering an Upgrade Task

Function

Triggers a desktop upgrade task based on the configured parameters.

Forcible upgrade, version designation, timeout control, and notification are supported.
The task is executed immediately after being triggered, and is not affected by task scheduling.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

workspace:upgradeTask:execute

Write

-

-

-

-

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
workspace:upgradeTask:execute	Write	-	-	-	-

URI

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

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
is_force_execute	Yes	Integer	Whether to forcibly upgrade the version. The value can be 0 (no) or 1 (yes).
target_version	Yes	String	Target version.
description	No	String	Upgrade task description.
is_notify	Yes	Integer	Whether to enable the notification. The value can be 0 (no) or 1 (yes).
extra_params	No	String	Extended parameter (in JSON format).
desktop_sids	No	Array of strings	Desktop SID list.

Response Parameters

Status code: 200

Status code: 400

**Table 3** Response body parameters
Parameter	Type	Description
error_code	String	Service error code.
error_msg	String	Service error message.

Status code: 500

**Table 4** Response body parameters
Parameter	Type	Description
error_code	String	Service error code.
error_msg	String	Service error message.

Example Requests

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