Checking the Progress of an Asynchronous Job (Version 2)

Function

This API is used to check the PDF report generation progress based on the value of asyncJobId returned by the API for generating a PDF report.

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:getReport	Read	task *	-	-	-
codeartscheck:task:getReport	Read	-	codeartscheck:ProjectId	-	-

URI

GET /v2/async-job

**Table 1** Query 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 32 characters. Default value: N/A
async_job_id	Yes	Integer	Definition: Asynchronous job ID. Obtain the ID from the response body of the API for [generating a PDF report]. Constraints: N/A Value range: N/A Default value: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Language	No	String	Definition: Language of the response. Constraints: N/A Value range: zh-cn: Chinese. en-us: English. Default value: zh-cn

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
status	String	Definition: Response status. Value range: success: successful. error: failed.
error	Error object	Definition Error message. This parameter is returned only when the operation fails.
result	AsyncJob object	Definition: Asynchronous task.

**Table 4** Error
Parameter	Type	Description
error_code	String	Definition: Error code. Value range: N/A
error_msg	String	Definition Error description of the current interface exception. Range N/A
reason	String	Definition: Details. Value range: N/A

**Table 5** AsyncJob
Parameter	Type	Description
id	Integer	Definition: Asynchronous job ID. Value range: N/A
jobFile	String	Definition: Path of the exported file. Value range: N/A
jobStatus	String	Definition: Asynchronous task status. Value range: SUCCESS: successful. RUNNING: running. FAILED: failed.
createTime	String	Definition: Time (GMT+8) when an asynchronous task is created. Format: yyyy-MM-dd HH:mm:ss. For example, 2020-09-25 12:05:00. Value range: N/A
progress	String	Definition Progresses of an asynchronous task. For example, 100 indicates that the task is 100/ %completed. Range 1~100
reason	String	Definition: Asynchronous task failure cause. Value range: N/A
taskId	String	Definition Task ID. Range N/A

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 progress of the asynchronous export task whose async_job_id is 4xx9 in the task whose ID is 897acf5exxx48a5013cd.

GET https://{endpoint}/v2/async-job?task_id=897acf5exxx48a5013cd&async_job_id=4xx9

Example Responses

Status code: 200

Request succeeded.

{
  "status" : "success",
  "error" : null,
  "result" : {
    "id" : 4009,
    "jobFile" : "defects/PdfFiles/20250923/local_test_master_Code check report_20250923164928.pdf",
    "jobStatus" : "SUCCESS",
    "createTime" : "2025-09-23 16:49:27",
    "progress" : "100",
    "taskId" : null,
    "reason" : null
  }
}

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."
}