Help Center/ CodeArts Check/ API Reference/ APIs/ Task Management/ Querying the Task Execution Status
Updated on 2023-11-28 GMT+08:00
View PDF

Querying the Task Execution Status

Function

Query the task execution status based on the task ID. Task status: 0 indicates that the task is being checked, 1 indicates that the check fails, 2 indicates that the check is successful, and 3 indicates that the task is stopped. The detailed progress information is displayed only when the check is in progress.

URI

GET /v2/tasks/{task_id}/progress

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

task_id

Yes

String

Task ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

It can be obtained by calling an IAM API. The value of X-Subject-Token in the response header is the user token.

Minimum: 1

Maximum: 100000

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

task_status

Integer

Specifies the task status. The value can be 0 (checking), 1 (check failed), 2 (check succeeded), or 3 (task stopped).

progress

ProgressDetailV2 object

Check Progress
Table 4 ProgressDetailV2

Parameter

Type

Description

ratio

String

Progress Percentage

info

String

Progress

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error Codes

error_msg

String

Description

Example Requests

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

Example Responses

Status code: 200

Request succeeded!

{
  "task_status" : 0,
  "progress" : {
    "ratio" : "50%",
    "info" : "Performing the check..."
  }
}

Status code: 400

Bad Request

{
  "error_code" : "CC.00000000",
  "error_msg" : "The network is busy. Please try again later."
}

Status code: 401

Unauthorized

{
  "error_code" : "CC.00000003",
  "error_msg" : "The authentication information has expired."
}

Status Codes

Status Code

Description

200

Request succeeded!

400

Bad Request

401

Unauthorized

Error Codes

See Error Codes.

Parent topic: Task Management