更新时间:2025-08-19 GMT+08:00

历史扫描结果查询

功能介绍

查询某个任务在时间范围内每次扫描各个问题级别的问题数量。

调用方法

请参见如何调用API

URI

GET /v2/{project_id}/tasks/{task_id}/checkrecord

表1 路径参数

参数

是否必选

参数类型

描述

task_id

String

参数解释:

任务ID,即新建检查任务接口的返回值,每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

project_id

String

参数解释:

项目的32位uuid,项目唯一标识,通过查询项目列表接口查询项目列表获取。

约束限制:

不涉及。

取值范围:

32位项目ID。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

参数解释:

页码,类似page_num的作用。

约束限制:

不涉及。

取值范围:

0-999999

limit

Integer

参数解释:

每页数量,类似page_size的作用。

约束限制:

不涉及。

取值范围:

1-1000

start_time

String

参数解释:

任务检查开始时间。使用UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ。例如:2020-09-25T12:05:00Z。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

2000-01-01T00:00:00Z

end_time

String

参数解释:

任务检查结束时间。使用UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ。例如:2020-09-25T12:05:00Z。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

当前时间。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

不涉及。

取值范围:

字符串长度不少于1,不超过10万。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

data

Array of CheckRecordDataInfo objects

参数解释:

每次扫描的各个问题级别的问题数量。

取值范围:

不涉及。

total

Integer

参数解释:

扫描次数总数。

取值范围:

不涉及。

表5 CheckRecordDataInfo

参数

参数类型

描述

jobId

String

参数解释:

执行ID。版本级不传,门禁级必传。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

check_time

String

参数解释:

检查任务执行开始时间,使用UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ。

取值范围:

不涉及。

check_end_time

String

参数解释:

检查任务执行结束时间,使用UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ。

取值范围:

不涉及。

issue_counts

CheckRecordIssueCountsInfo object

参数解释:

各个问题级别的问题数量。

取值范围:

不涉及。

表6 CheckRecordIssueCountsInfo

参数

参数类型

描述

critical

Integer

参数解释:

致命问题数量。

取值范围:

不涉及。

serious

Integer

参数解释:

严重问题数量。

取值范围:

不涉及。

normal

Integer

参数解释:

一般问题数量。

取值范围:

不涉及。

prompt

Integer

参数解释:

提示问题数量。

取值范围:

不涉及。

状态码:400

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

在ID为e04b357xxxxx5ed832xxxxxx的项目下,查询ID为2b31ed520xxxxxxebedb6e57xxxxxxxx的任务在UTC时间2025-06-01T00:00:00Z到2025-06-10T00:00:00Z之间的所有扫描结果数据

GET https://{endpoint}/v2/363540xxxxxxxx5105099944xxxxxxxx/tasks/2b31ed520xxxxxxebedb6e57xxxxxxxx/checkrecord?start_time=2025-06-01T00:00:00Z&end_time=2025-06-10T00:00:00Z

null

响应示例

状态码:200

Request succeeded!

{
  "total" : 100,
  "data" : [ {
    "check_time" : "2023-11-29T05:28:41Z",
    "check_end_time" : "2023-11-29T05:30:38Z",
    "job_id" : "84xxxxxxxxxxxxxxxxxxxxxxxxxxxx6f",
    "issue_counts" : {
      "critical" : 0,
      "serious" : 1,
      "normal" : 2,
      "prompt" : 3
    }
  }, {
    "check_time" : "2023-09-29T05:28:41Z",
    "check_end_time" : "2023-09-29T05:30:38Z",
    "job_id" : "a4xxxxxxxxxxxxxxxxxxxxxxxxxxxxb1",
    "issue_counts" : {
      "critical" : 0,
      "serious" : 1,
      "normal" : 2,
      "prompt" : 3
    }
  } ]
}

状态码: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

错误码

请参见错误码