Help Center/ Workspace/ API Reference/ Workspace Application Streaming APIs/ Scheduled Task/ Modifying a Scheduled Task
Updated on 2026-05-21 GMT+08:00
View PDF
Share

Modifying a Scheduled Task

Function

Modifies a scheduled task.

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:scheduledTasks:update

    Write

    scheduledTask *

    -

    -

    -

    desktop

    -

    desktopPool

    -

    server

    -

    serverGroup

    -

URI

PATCH /v1/{project_id}/schedule-task/{task_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Unique ID of a project

task_id

Yes

String

Unique ID of a scheduled task.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

scheduled_type

No

String

Cycle Frequency

  • FIXED_TIME - Specified time

  • DAY: by day

  • WEEK: by week

  • MONTH - by month.

day_interval

No

Integer

If the period is by day, the task is executed at an interval of x days.

week_list

No

String

If the period is by week, the value ranges from 1 to 7. Multiple values are separated by commas (,), for example, 1,2,7.

month_list

No

String

If the period is by month, the value ranges from 1 to 12. Multiple values are separated by commas (,), for example, 1,3,12.

date_list

No

String

If the period is by month, the value ranges from 1 to 31 and L (indicating the last day of the current month). The values are separated by commas (,), for example, 1,2,28,L.

time_zone

No

String

Time zone.

scheduled_date

No

String

If the period is specified, the value is a specified date in yyyy-MM-dd.

scheduled_time

No

String

Specified execution time. The format is HH:mm:ss.

expire_time

No

String

Expiration time.

task_name

No

String

Task name, which must meet the following requirements:

  1. The value consists of uppercase letters, lowercase letters, digits, underscores (_), and hyphens (-), and cannot contain spaces.

  2. The value contains 1 to 64 characters.

task_type

No

String

Scheduled task type

  • RESTART_SERVER - Periodically restarts the server.

  • START_SERVER - Scheduled startup

  • STOP_SERVER - Scheduled shutdown

  • REINSTALL_OS - Scheduled OS reinstallation.

schedule_task_policy

No

ScheduleTaskPolicy object

Scheduled task policy.

description

No

String

Task Description.

is_enable

No

Boolean

Enable Configuration

true: yes

false: disabled.

target_infos

No

Array of TargetInfo objects

List of Scheduled Task Objects.
Table 4 ScheduleTaskPolicy

Parameter

Mandatory

Type

Description

enforcement_enable

No

Boolean

Whether to enable force execution when a session exists. Options:

false: disable

true: enable
Table 5 TargetInfo

Parameter

Mandatory

Type

Description

target_type

Yes

String

Scheduled task object type

  • SERVER - Server

  • SERVER_GROUP - Server group.

target_id

Yes

String

Specifies the object ID.

Response Parameters

Status code: 200

Table 6 Response body parameters

Parameter

Type

Description

id

String

Primary key ID of a scheduled task.

task_name

String

Task Name.

last_status

String

Last Execution Status.

task_type

String

Scheduled task type

  • RESTART_SERVER - Periodically restarts the server.

  • START_SERVER - Scheduled startup

  • STOP_SERVER - Scheduled shutdown

  • REINSTALL_OS - Scheduled OS reinstallation.

task_cron

String

Scheduled task expression.

next_execution_time

String

Next execution time.

schedule_task_policy

ScheduleTaskPolicy object

Scheduled task policy.

scheduled_type

String

Cycle Frequency

  • FIXED_TIME - Specified time

  • DAY: by day

  • WEEK: by week

  • MONTH - by month.

day_interval

Integer

If the period is by day, the task is executed at an interval of x days.

week_list

String

If the period is by week, the value ranges from 1 to 7. Multiple values are separated by commas (,), for example, 1,2,7.

month_list

String

If the period is by month, the value ranges from 1 to 12. Multiple values are separated by commas (,), for example, 1,3,12.

date_list

String

If the period is by month, the value ranges from 1 to 31 and L (indicating the last day of the current month). The values are separated by commas (,), for example, 1,2,28,L.

time_zone

String

Time Zone.

scheduled_date

String

If the period is specified, the value is a specified date in yyyy-MM-dd.

scheduled_time

String

Specified execution time. The format is HH:mm:ss.

expire_time

String

Expiration time.

description

String

Task Description.

is_enable

Boolean

Indicates whether the function is enabled.

create_time

String

Creation time.

update_time

String

Update time.
Table 7 ScheduleTaskPolicy

Parameter

Type

Description

enforcement_enable

Boolean

Whether to enable force execution when a session exists. Options:

false: disable

true: enable

Status code: 400

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 401

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 403

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 404

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 405

Table 12 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 500

Table 13 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 503

Table 14 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Example Requests

{
  "scheduled_type" : "day",
  "day_interval" : 1,
  "week_list" : "1,2,7",
  "month_list" : "1,3,12",
  "date_list" : "1,2,28,L",
  "time_zone" : "Asia/Shanghai",
  "scheduled_date" : "2022-12-23",
  "scheduled_time" : "09:00:00",
  "expire_time" : "2022-03-07T10:40:43.858Z",
  "task_name" : "Scheduled Startup Task",
  "task_type" : "RESTART_SERVER",
  "schedule_task_policy" : {
    "enforcement_enable" : false
  },
  "description" : "Used for power-on and power-off",
  "is_enable" : true,
  "target_infos" : [ {
    "target_type" : "SERVER",
    "target_id" : [ "3f791197-d166-4c8e-81e4-38c40ffc1989" ]
  } ]
}

Example Responses

Status code: 200

Response to a successful request.

{
  "id" : "62f48b59-0ebb-4b1e-ad35-f64948a0591b",
  "task_name" : "Scheduled Startup Task",
  "last_status" : "WAITING",
  "task_type" : "RESTART_SERVER",
  "task_cron" : "*/10 * * * * ?",
  "next_execution_time" : "2022-12-23 09:00:00",
  "schedule_task_policy" : {
    "enforcement_enable" : false
  },
  "scheduled_type" : "day",
  "day_interval" : 1,
  "week_list" : "1,2,7",
  "month_list" : "1,3,12",
  "date_list" : "1,2,28,L",
  "time_zone" : "Asia/Shanghai",
  "scheduled_date" : "2022-12-23",
  "scheduled_time" : "09:00:00",
  "expire_time" : "2022-03-07T10:40:43.858Z",
  "description" : "Used for power-on and power-off",
  "is_enable" : false,
  "create_time" : "2022-03-07T10:40:43.858Z",
  "update_time" : "2024-12-25T12:38:27.942Z"
}

Status Codes

Status Code

Description

200

Response to a successful request.

400

The request cannot be understood by the server due to malformed syntax.

401

Authentication failed.

403

Permissions required.

404

No resources found.

405

The request method is not allowed.

500

An internal service error occurred. For details, see the error code description.

503

Service unavailable.

Error Codes

See Error Codes.

Parent topic: Scheduled Task