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

Querying the Status of a Task

Function

This API is used to query the task status based on the task ID (0: being checked; 1: failed; 2: successful; 3: stopped). Only tasks being executed have progress details.

Calling Method

For details, see Calling APIs.

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 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 3 Response body parameters

Parameter

Type

Description

task_status

Integer

Task status: 0: being checked; 1: failed; 2: successful; 3: stopped.

progress

ProgressDetailV2 object

Check progress.
Table 4 ProgressDetailV2

Parameter

Type

Description

ratio

String

Progress percentage.

info

String

Progress information.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error message.

Example Requests

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

Example Responses

Status code: 200

Request succeeded!

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

Status code: 400

Bad Request

{
  "error_code" : "CC.00000000",
  "error_msg" : "Network busy. Try again later."
}

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