Help Center/ Workspace/ API Reference/ Workspace APIs/ Scheduled Tasks/ Querying Details About Scheduled Task Execution Records
Updated on 2025-07-14 GMT+08:00

Querying Details About Scheduled Task Execution Records

Function

Query details about scheduled task execution records.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v2/{project_id}/scheduled-tasks/{task_id}/records/{record_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

task_id

Yes

String

Task ID.

record_id

Yes

String

ID of a task execution record.

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

offset

Yes

Integer

Start position for pagination query. The value starts from 0.

limit

Yes

Integer

Number of records displayed on each page. The value ranges from 0 to 100.

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

tasks_records_details

Array of ScheduledTasksRecordsDetails objects

Scheduled task execution records.

total_count

Integer

Total number.

Table 5 ScheduledTasksRecordsDetails

Parameter

Type

Description

id

String

Task execution record detail ID.

record_id

String

Task execution record ID.

desktop_id

String

Desktop ID.

desktop_name

String

Desktop name.

exec_status

String

Execution status.

exec_script_id

String

ID of the script to be executed.

result_code

String

Error code of the cause of failure or skip.

fail_reason

String

Cause of failure or skip.

start_time

String

Execution start time in yyyy-MM-dd HH:mm:ss.

end_time

String

Execution end time in yyyy-MM-dd HH:mm:ss.

time_zone

String

Time zone.

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

error_detail

String

Error details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Status code: 500

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code, which is returned upon failure.

error_msg

String

Error description.

error_detail

String

Error details.

encoded_authorization_message

String

Encrypted detailed reason for rejection. You can call the API decode-authorization-message of STS to decrypt the reason.

Example Requests

None

Example Responses

Status code: 200

Normal.

{
  "tasks_records_details" : [ {
    "id" : "2b31e-d520xxxx-xxebedb6-e57xxxxxx",
    "record_id" : "2b31e-d520xxxx-xxebedb6-e57xxxxxx",
    "desktop_id" : "2b31e-d520xxxx-xxebedb6-e57xxxxxx",
    "desktop_name" : "desktop1",
    "exec_status" : "SUCCESS",
    "exec_script_id" : "string",
    "result_code" : "WKS.000x",
    "fail_reason" : "Task conflict",
    "start_time" : "2022-12-31 09:00:00",
    "end_time" : "2022-12-31 09:00:00",
    "time_zone" : "Asia/Shanghai"
  } ],
  "total_count" : 10
}

Status Codes

Status Code

Description

200

Normal.

400

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

500

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

Error Codes

See Error Codes.