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

Querying Scheduled Tasks

Function

Queries the name (fuzzy match).

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

    List

    scheduledTask *

    -

    -

    -

URI

GET /v1/{project_id}/schedule-task

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Unique ID of a project
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

No

Integer

Query offset. The default value is 0.

limit

No

Integer

Number of records to be queried. The value ranges from 1 to 100. The default value is 10.

task_name

No

String

Scheduled task name.

task_type

No

String

Task type:

RESTART_SERVER: Scheduled server restart.

START_SERVER: Scheduled server startup.

STOP_SERVER: Scheduled server shutdown.

REINSTALL_OS: Scheduled OS reinstallation.

Request Parameters

Table 3 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.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

count

Integer

Total number.

items

Array of ScheduleTask objects

Scheduled task list. The maximum number of records in the list is the maximum number of records on each page.
Table 5 ScheduleTask

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 6 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 7 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 8 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 9 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 10 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 11 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 12 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 13 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Example Requests

None

Example Responses

Status code: 200

Response to a successful request.

{
  "count" : 0,
  "items" : [ {
    "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:49:02.230Z"
  } ]
}

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