查询异步任务进度
功能介绍
根据生成PDF报告接口返回的asyncJobId，查询生成PDF的进度
调用方法
请参见如何调用API。
URI
GET /v1/tasks/{task_id}/async-job/{async_job_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
task_id |
是 |
String |
参数解释： 任务ID，即新建检查任务接口的返回值，每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
async_job_id |
是 |
Integer |
参数解释： 异步任务ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Language |
否 |
String |
参数解释： 语言，决定响应以哪种语言返回。 约束限制： 不涉及。 取值范围：
默认取值： zh-cn |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
String |
参数解释： 响应状态。 取值范围：
|
|
result |
AsyncJob object |
参数解释： 异步任务。 约束限制： 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
Integer |
参数解释： 异步任务ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
jobFile |
String |
参数解释： 导出文件的路径。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
jobStatus |
String |
参数解释： 异步任务状态。 约束限制： 不涉及。 取值范围： SUCCESS，成功 RUNNING，运行中 FAILED，失败 默认取值： 不涉及。 |
|
createTime |
String |
参数解释： 异步任务创建时间。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
progress |
String |
参数解释： 异步任务进度。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
reason |
String |
参数解释： 异步任务失败原因。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
查询ID为897acf5exxx48a5013cd的任务下，ID为4xx9的异步导出任务进度。
GET https://{endpoint}/v1/tasks/897acf5exxx48a5013cd/async-job/4xx9
响应示例
状态码：200
查询异步任务进度响应体
{
"status" : "success",
"error" : null,
"result" : {
"id" : 569151,
"jobFile" : "defects/PdfFiles/20250923/local_test_master_代码扫描报告_20250923164928.pdf",
"jobStatus" : "SUCCESS",
"createTime" : "2025-09-23 16:49:27",
"progress" : "100",
"taskId" : null,
"reason" : null
}
}
状态码：400
Bad Request
{
"error_code" : "CC.00000000",
"error_msg" : "网络繁忙，请稍后再试"
}
状态码：401
Unauthorized
{
"error_code" : "CC.00000003",
"error_msg" : "认证信息过期"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询异步任务进度响应体 |
|
400 |
Bad Request |
|
401 |
Unauthorized |
错误码
请参见错误码。
