文档首页/代码检查 CodeArts Check/API参考/API/问题导出/查询异步任务进度 - GetAsyncJob
更新时间：2025-12-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询异步任务进度 - GetAsyncJob

功能介绍

根据生成PDF报告接口返回的asyncJobId，查询生成PDF的进度。

调用方法

请参见如何调用API。

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

codeartscheck:task:getReport

Read

task *

-

-

-

-

codeartscheck:ProjectId

URI

GET /v1/tasks/{task_id}/async-job/{async_job_id}

表1 路径参数

参数

是否必选

参数类型

描述

task_id

是

String

参数解释：

任务ID，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即查询任务列表接口响应中的id字段。

约束限制：

不涉及。

取值范围：

长度为[1~128]个字符。

默认取值：

不涉及。

async_job_id

是

Integer

参数解释：

异步任务ID，从[生成PDF报告]接口响应体中获取。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Language

否

String

参数解释：

语言，决定响应以哪种语言返回。

约束限制：

不涉及。

取值范围：

  • zh-cn：中文。

  • en-us：英文。

默认取值：

zh-cn。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

status

String

参数解释：

响应状态。

取值范围：

  • success：成功。

  • error：失败。

result

AsyncJob object

参数解释：

异步任务。

表4 AsyncJob

参数

参数类型

描述

id

Integer

参数解释：

异步任务ID。

取值范围：

不涉及。

jobFile

String

参数解释：

导出文件的路径。

取值范围：

不涉及。

jobStatus

String

参数解释：

异步任务状态。

取值范围：

  • SUCCESS：成功。

  • RUNNING：运行中。

  • FAILED：失败。

createTime

String

参数解释：

异步任务创建时间。使用GMT+8时间，格式为yyyy-MM-dd HH:mm:ss。例如：2020-09-25 12:05:00。

取值范围：

不涉及。

progress

String

参数解释：

异步任务进度。例如100，表示已完成100%

取值范围：

1-100

reason

String

参数解释：

异步任务失败原因。

取值范围：

不涉及。

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

状态码：401

表6 响应Body参数

参数

参数类型

描述

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.xxxxxxxx.400",
  "error_msg" : "请求参数校验失败,请检查请求参数是否正确"
}

状态码：401

Unauthorized

{
  "error_code" : "CC.00000003",
  "error_msg" : "认证信息过期"
}

状态码

状态码

描述

200

查询异步任务进度响应体

400

Bad Request

401

Unauthorized

错误码

请参见错误码。

父主题： 问题导出

相关文档