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

查询缺陷概要

功能介绍

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

调用方法

请参见如何调用API

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

task_id

String

参数解释:

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

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

job_id

String

参数解释:

执行记录ID,即每一次执行版本级或门禁级扫描的唯一ID,主要用于查询门禁级任务。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

merge_id

String

参数解释:

合并请求ID或Commit ID,主要用于查询门禁级任务。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

taskId

String

参数解释:

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

参数解释:

门禁质量是否通过。

取值范围:

不涉及。

review_result

String

参数解释:

门禁质量是否通过。

取值范围:

不涉及。

trigger_type

String

参数解释:

任务触发方式。

取值范围:

不涉及。

file_duplication_ratio

String

参数解释:

文件重复率。

取值范围:

不涉及。

new_count

Integer

参数解释:

待处理问题数。

取值范围:

不涉及。

solve_count

Integer

参数解释:

已解决问题数。

取值范围:

不涉及。

dismissed_count

Integer

参数解释:

已忽略问题数 。

取值范围:

不涉及。

duplicated_files

Integer

参数解释:

重复文件数量。

取值范围:

不涉及。

new_critical_count

String

参数解释:

新增致命问题数。

取值范围:

不涉及。

new_major_count

String

参数解释:

新增严重问题数。

取值范围:

不涉及。

new_minor_count

String

参数解释:

新增一般问题数。

取值范围:

不涉及。

new_suggestion_count

String

参数解释:

新增提示问题数。

取值范围:

不涉及。

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

查询ID为2b31ed520xxxxxxebedb6e57xxxxxxxx的任务的缺陷概要

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

null

响应示例

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

错误码

请参见错误码