Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Querying the Status of a Task
Updated on 2026-08-10 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying the Status of a Task

Function

Query the task execution status based on the task ID. The progress details are displayed only when the task is being checked.

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 /v2/tasks/{task_id}/progress

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

task_id

Yes

String

Definition :

Task ID, which is the return value of the API used to create a check task. Each check task, its brach tasks, and incremental tasks created through APIs have a unique task ID. Obtain the ID by calling the API used to query the task list. id indicates the task ID.

Constraints:

N/A.

Value range:

1 to 32 characters.

Default value:

N/A.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

job_id

No

String

Definition

Execution record ID, that is, the unique ID of each version or quality gate scan. The ID is used to query quality gate tasks.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 3 Request header parameters

Parameter

Mandatory

Type

Description

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

Range

The length is the value of [1-100000].

Default Value

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

task_status

Integer

Definition:

Check the task execution status.

Range

  • 0: checking

  • 1: check failed

  • 2: check successful

  • 3: check stopped

  • null: not yet checked

progress

ProgressDetailV2 object

Definition:

Check progress.
Table 5 ProgressDetailV2

Parameter

Type

Description

ratio

String

Definition

Check progress, in percentage.

Range

0%–100%: checking or check successful

null: check failed, check stopped, or not yet checked

info

String

Definition

Check status.

Range

  • running: checking

  • success: check successful

  • null: check failed, check stopped, or not yet checked

Status code: 400

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

Status code: 401

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

Query the execution status of the code check task whose ID is 2b31ed520xxxxxxebedb6e57xxxxxxxx.

GET https://{endpoint}/v2/tasks/2b31ed520xxxxxxebedb6e57xxxxxxxx/progress

Example Responses

Status code: 200

Request succeeded.

{
  "task_status" : 0,
  "progress" : {
    "ratio" : "50%",
    "info" : "running"
  }
}

Status code: 400

A request error occurred.

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

Status code: 401

The permission is insufficient.

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

Status Codes

Status Code

Description

200

Request succeeded.

400

A request error occurred.

401

The permission is insufficient.

Error Codes

See Error Codes.

Parent Topic: Task Management