Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Querying the Scheduled Task Configuration
Updated on 2026-02-03 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Scheduled Task Configuration

Function

This API is used to query the scheduled task configuration of a task based on the task ID. The returned result includes the week, time, time zone offset, and whether the scheduled task function is enabled.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartscheck:task:get

Read

task *

-

-

-

-

codeartscheck:ProjectId

URI

GET /v1/tasks/{task_id}/taskcron

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

task_id

Yes

String

Definition :

Task ID, returned by the API for creating a check task. Each code check task, branch task, or incremental task generated through an API has a unique ID. Obtain the ID by calling the API used to . id indicates the task ID.

Constraints:

N/A

Value range:

1 to 128 characters.

Default value:

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

operator

No

String

Definition:

Operator username.

Constraints:

N/A

Constraints:

1 to 128 characters.

Default value:

N/A

X-Auth-Token

Yes

String

Definition :

User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token.

Constraints:

N/A

Value range:

1–100,000 characters.

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

status

String

Definition:

Response status.

Range:

success: successful.

failed: failed.

httpStatus

Integer

Definition:

Response status code.

Range:

ok: successful.

failed: failed.

result

TaskCronResult object

Definition:

Scheduled task configuration.

Range:

N/A
Table 4 TaskCronResult

Parameter

Type

Description

taskId

String

Definition :

Task ID, returned by the API for creating a check task. Each code check task, branch task, or incremental task generated through an API has a unique ID. Obtain the ID by calling the API used to . id indicates the task ID.

Constraints:

N/A

Value range:

1 to 32 characters.

Default value:

N/A

cronStatus

String

Definition:

Scheduled task status.

Value range:

  • 0: disabled.

  • 1: enabled.

weekDays

Array of strings

Definition:

Days when a scheduled task is executed.

Range:

0–6: Sunday to Saturday.

detailTime

String

Definition:

Time when a scheduled task is executed.

Range:

Time in 24-hour format.

creator

String

Definition:

Creator of a scheduled task.

Range:

N/A

timeOffset

String

Definition:

Time offset in GMT format.

Range:

Time offset in GMT format.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

Example Requests

This API is used to query the scheduled task configuration.

GET https://{endpoint}/v1/tasks/fxxxx7ba3ae14a87a32b151bcbe20801/taskcron

Example Responses

Status code: 200

Request succeeded!

{
  "status" : "success",
  "httpStatus" : "OK",
  "result" : {
    "taskId" : "fxxxx7ba3ae14a87a32b151bcbe20801",
    "cronStatus" : "0",
    "weekDays" : [ "0", "1", "2" ],
    "detailTime" : "15:00",
    "creator" : "creator",
    "timeOffset" : "GMT+08:00"
  }
}

Status code: 400

Bad Request

{
  "error_code" : "CC.xxxxxxxx.400",
  "error_msg" : "Verify request parameter failed. Check whether the request parameters are correct."
}

Status code: 401

Unauthorized

{
  "error_code" : "CC.00000003",
  "error_msg" : "Authentication information expired."
}

Status Codes

Status Code

Description

200

Request succeeded!

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.

Parent Topic: Task Management