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

Querying Details About a Specified Scheduled Task

Function

Queries details about a specified 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:get

    Read

    scheduledTask *

    -

    -

    -

URI

GET /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.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

id

String

Task ID.

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_name

String

Task name.

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. The format is yyyy-MM-ddTHH:mm:ssZ (example: 2016-06-28T00:00:00Z).

description

String

Description.

target_infos

Array of TargetInfo objects

Objects to which a scheduled task applies.
Table 4 ScheduleTaskPolicy

Parameter

Type

Description

enforcement_enable

Boolean

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

false: disable

true: enable
Table 5 TargetInfo

Parameter

Type

Description

target_type

String

Scheduled task object type

  • SERVER - Server

  • SERVER_GROUP - Server group.

target_id

String

Specifies the object ID.

target_name

String

Object name.

Status code: 400

Table 6 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 7 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 8 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 9 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 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error message.

Status code: 409

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

Successful.

{
  "id" : "2b31e-d520xxxx-xxebedb6-e57xxxxxx",
  "task_type" : "RESTART_SERVER",
  "task_name" : "Test Tasks",
  "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" : "One description.",
  "target_infos" : [ {
    "target_type" : "SERVER",
    "target_id" : [ "3f791197-d166-4c8e-81e4-38c40ffc1989" ],
    "target_name" : "Test desktop"
  } ]
}

Status Codes

Status Code

Description

200

Successful.

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.

409

The request fails to be processed because a conflict exists.

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