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
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
task_id |
Yes |
String |
Definition Task ID, returned by the API for creating a check task. Each CodeArts Check task, branch task, or incremental task generated through an API has a unique ID. Constraints N/A Range N/A Default Value N/A |
Request Parameters
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
X-Auth-Token |
Yes |
String |
Definition User token. Obtain a token by calling the IAM API forobtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints N/A Range 1–100,000 characters Default Value N/A |
Response Parameters
Status code: 200
Parameter |
Type |
Description |
---|---|---|
task_status |
Integer |
Definition Check status. Range
|
progress |
ProgressDetailV2 object |
Definition Check progress. Range N/A |
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
|
Status code: 400
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error message. |
Status code: 401
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" : "running" } }
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.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot