更新时间:2024-11-28 GMT+08:00

历史扫描结果查询

功能介绍

提供每次扫描的问题数量统计

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,每个CodeArts首页下的项目都有1个唯一的项目ID

task_id

String

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

表2 Query参数

参数

是否必选

参数类型

描述

offset

Integer

分页索引,偏移量

limit

Integer

每页显示的数量,每页最多显示1000条

start_time

String

过滤开始时间,根据任务检查开始时间过滤

end_time

String

过滤结束时间,根据任务检查结束时间过滤

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token

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

响应参数

状态码: 200

表4 响应Body参数

参数

参数类型

描述

data

Array of CheckRecordDataInfo objects

历史记录数据

total

Integer

总数

表5 CheckRecordDataInfo

参数

参数类型

描述

check_time

String

检查任务执行开始时间

check_end_time

String

检查任务执行结束时间

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

错误描述

请求示例

GET https://{endpoint}/v2/{project_id}/tasks/{task_id}/checkrecord

响应示例

状态码: 200

Request succeeded!

{
  "total" : 100,
  "data" : [ {
    "check_time" : "2020-02-20 11:37:46",
    "check_end_time" : "2020-02-20 11:47:46",
    "issue_counts" : {
      "critical" : 0,
      "serious" : 1,
      "normal" : 2,
      "prompt" : 3
    }
  }, {
    "check_time" : "2020-02-20 11:37:46",
    "check_end_time" : "2020-02-20 11:47:46",
    "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

错误码

请参见错误码