Listing Upgrade Tasks

Function

Lists upgrade tasks by page.

You can query tasks by task name (fuzzy match), task type, execution period type, enabling status, and last execution status.
By default, tasks are sorted in descending order of creation time.

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:list

List

-

-

-

-

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

URI

GET /v2/{project_id}/upgrade-tasks

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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
task_id	No	String	Task ID.
task_name	No	String	Task name. Fuzzy search is supported.
task_type	No	Integer	Task type. The value can be 0 (cloud desktop), 1 (application server), or 2 (image).
scheduled_type	No	String	Execution period type. The value can be FIXED_TIME (specified time), DAY (by day), WEEK (by week), or MONTH (by month).
is_enable	No	Integer	Enabling status. The value can be 0 (disabled) or 1 (enabled).
last_execute_status	No	String	Last execution status.
offset	No	Integer	Offset. The default value is 0.
limit	No	Integer	Number of records on each page. The default value is 10, and the maximum value is 100.

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
total	Integer	Total quantity.
tasks	Array of UpgradeScheduledTaskVO objects	Task list.

**Table 4** UpgradeScheduledTaskVO
Parameter	Type	Description
id	String	Task ID.
task_name	String	Task name.
task_type	Integer	Task type. The value can be 0 (cloud desktop), 1 (application server), or 2 (image).
scheduled_type	String	Execution period type. The value can be FIXED_TIME (specified time), DAY (by day), WEEK (by week), or MONTH (by month).
timezone	String	Time zone.
last_execute_status	String	Latest execution status. The value can be SUCCESS, FAILED, RUNNING, or WAITING.
next_execute_time	String	Next execution time.
is_enable	Integer	Enabling status. The value can be 0 (disabled) or 1 (enabled).
target_version	String	Target version.
execute_strategy	Integer	Execution policy. The value can be 0 (full delivery) or 1 (grayscale delivery).
description	String	Task description.

Status code: 400

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

Status code: 500

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

Example Requests

None

Example Responses

Status code: 200

{
  "total" : 100,
  "tasks" : [ {
    "id" : "task-001",
    "task_name" : "Daily Desktop Upgrade Task",
    "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" : "Desktop upgrade is performed at 02:00 every day."
  } ]
}