查询任务执行状态
功能介绍
根据任务ID查询任务执行状态。任务状态：0表示检查中，1表示检查失败，2表示检查成功，3表示任务中止。只有正在检查中才有进度的详细信息。
调用方法
请参见如何调用API。
URI
GET /v2/tasks/{task_id}/progress
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
task_id |
是 |
String |
参数解释： 任务ID，即新建检查任务接口的返回值，每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
job_id |
否 |
String |
参数解释： 执行记录ID，即每一次执行版本级或门禁级扫描的唯一ID，主要用于查询门禁级任务。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 不涉及。 取值范围： 字符串长度不少于1，不超过10万。 默认取值： 不涉及。 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
task_status |
Integer |
参数解释: 检查执行状态。 取值范围:
|
|
progress |
ProgressDetailV2 object |
参数解释: 检查执行进度。 取值范围: 不涉及。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
ratio |
String |
参数解释: 检查进度百分比。 取值范围: 检查中、检查成功时，为0%-100%； 检查失败、任务中止、未检查时，为null。 |
|
info |
String |
参数解释: 检查执行状态。 取值范围:
|
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
请求示例
GET https://{endpoint}/v2/tasks/2b31ed520xxxxxxebedb6e57xxxxxxxx/progress
响应示例
状态码：200
Request succeeded!
{
"task_status" : 0,
"progress" : {
"ratio" : "50%",
"info" : "running"
}
}
状态码：400
Bad Request
{
"error_code" : "CC.00000000",
"error_msg" : "网络繁忙，请稍后再试"
}
状态码：401
Unauthorized
{
"error_code" : "CC.00000003",
"error_msg" : "认证信息过期"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
Request succeeded! |
|
400 |
Bad Request |
|
401 |
Unauthorized |
错误码
请参见错误码。
