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

Querying Scheduled Task Execution

Function

Queries scheduled task execution.

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

    List

    scheduledTask *

    -

    -

    -

URI

GET /v1/{project_id}/schedule-task/{task_id}/execute-history

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

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 ScheduleTaskExecuteHistory objects

List of scheduled task execution records. The maximum number of returned records is the maximum number of records on each page.
Table 5 ScheduleTaskExecuteHistory

Parameter

Type

Description

id

String

Primary key ID of the scheduled task execution record.

task_id

String

Primary key ID of a scheduled task.

task_type

String

Job type.

status

String

Scheduled task status.

scheduled_type

String

Scheduled task status.

total_count

Integer

Total number of subtasks.

success_count

Integer

Number of successful subtasks.

failed_count

Integer

Number of Failed Subtasks.

excuting_count

Integer

Number of subtasks that are being executed.

time_zone

String

Time zone.

begin_time

String

Task start time.

end_time

String

The task end time.

create_time

String

Creation time.

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

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

Table 12 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_id" : "62f48b59-0ebb-4b1e-ad35-f64948a0591b",
    "task_type" : "RESTART_SERVER",
    "status" : "WAITING",
    "scheduled_type" : "day",
    "total_count" : 10,
    "success_count" : 5,
    "failed_count" : 4,
    "excuting_count" : 4,
    "time_zone" : "Asia/Shanghai",
    "begin_time" : "2022-03-07T10:40:43.858Z",
    "end_time" : "2022-03-07T10:40:43.858Z",
    "create_time" : "2022-03-07T10:40:43.858Z"
  } ]
}

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