文档首页/ 代码检查 CodeArts Check/ API参考/ API/ 缺陷管理/ 查询缺陷概要
更新时间：2024-11-12 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询缺陷概要

功能介绍

根据检查任务ID查询缺陷结果的概要。包括问题概述、问题状态、圈复杂度、代码重复率等。

调用方法

请参见如何调用API。

URI

GET /v2/tasks/{task_id}/defects-summary

表1 路径参数

参数

是否必选

参数类型

描述

task_id

是

String

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

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

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

响应参数

状态码： 200

表3 响应Body参数

参数

参数类型

描述

task_id

String

任务id

task_name

String

任务名字

creator_id

String

创建者id

git_url

String

代码仓地址

git_branch

String

代码仓分支,如果是MR模式，为源分支

last_check_time

String

上一次检查时间

code_line_total

Integer

代码总行数

code_line

Integer

代码有效行数

code_quality

Number

代码质量

issue_count

Integer

问题数

risk_coefficient

Number

危险系数

duplication_ratio

String

重复比例

complexity_count

Integer

复杂度

duplicated_lines

Integer

重复行数

comment_lines

Integer

注释行数

comment_ratio

String

注释比例

duplicated_blocks

Integer

重复块

last_exec_time

String

上次执行时间

check_type

String

检查类型

created_at

String

创建时间

cyclomatic_complexity_per_method

String

代码平均复杂度

cyclomatic_complexity_per_file

String

代码平均复杂度(文件)

critical_count

String

致命问题数

major_count

String

严重问题数

minor_count

String

一般问题数

suggestion_count

String

提示问题数

is_access

String

门禁质量是否通过

trigger_type

String

任务触发方式

file_duplication_ratio

String

文件重复率

new_count

Integer

新增问题数

solve_count

Integer

已解决问题数

duplicated_files

Integer

重复文件数目

new_critical_count

String

新增致命问题数

new_major_count

String

新增严重问题数

new_minor_count

String

新增一般问题数

new_suggestion_count

String

新增提示问题数

状态码： 400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码： 401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://{endpoint}/v2/tasks/2b31ed520xxxxxxebedb6e57xxxxxxxx/defects-summary

响应示例

状态码： 200

Request succeeded!

{
  "task_id" : "435b58ecf7f54c45907c1384d01c94a6",
  "task_name" : "CSharp_02201119",
  "creator_id" : "ecadebb5041146cc96f9780f3d905e20",
  "git_url" : "git@****_02201119.git",
  "git_branch" : "master",
  "last_check_time" : "2020-02-20 11:37:46",
  "code_line_total" : 20,
  "code_line" : 156,
  "code_quality" : 147.4,
  "issue_count" : 3,
  "risk_coefficient" : 23,
  "duplication_ratio" : "0.0%",
  "complexity_count" : 0,
  "duplicated_lines" : 0,
  "comment_lines" : 0,
  "comment_ratio" : "0",
  "duplicated_blocks" : 0,
  "last_exec_time" : "2 分 28 秒",
  "check_type" : "source",
  "created_at" : "2020-02-20 11:21:11",
  "cyclomatic_complexity_per_method" : "84.0",
  "cyclomatic_complexity_per_file" : "112.0",
  "critical_count" : 2,
  "major_count" : 1,
  "minor_count" : 1,
  "suggestion_count" : 1,
  "is_access" : 0,
  "trigger_type" : 1,
  "file_duplication_ratio" : "33.3%",
  "new_count" : 0,
  "solve_count" : 0,
  "duplicated_files" : 0,
  "new_critical_count" : "0",
  "new_major_count" : "0",
  "new_minor_count" : "0",
  "new_suggestion_count" : "0"
}

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

错误码

请参见错误码。

父主题： 缺陷管理

相关文档