文档首页/代码检查 CodeArts Check/API参考/API/代码问题/查询问题和度量趋势 - DisplayTrend
更新时间：2025-12-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询问题和度量趋势 - DisplayTrend

功能介绍

查询指定时间内的每次扫描问题数量和度量指标趋势。

调用方法

请参见如何调用API。

授权信息

账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

codeartscheck:task:getReport

Read

task *

-

-

-

-

codeartscheck:ProjectId

URI

GET /v1/history/defect-metric-trend

表1 Query参数

参数

是否必选

参数类型

描述

task_id

是

String

参数解释：

任务ID，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即查询任务列表接口响应中的id字段。

约束限制：

不涉及。

取值范围：

长度为[1~32]个字符。

默认取值：

不涉及。

start_date

是

String

参数解释：

开始日期，使用UTC时间，格式为yyyy-MM-dd。例如：2025-11-20。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

end_date

是

String

参数解释：

结束日期，使用UTC时间，格式为yyyy-MM-dd。例如：2025-11-30。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

dimension

是

String

参数解释：

结果中扫描的显示频次。

约束限制：

不涉及。

取值范围：

  • times：每次扫描都显示。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Language

否

String

参数解释：

语言，决定响应以哪种语言返回。

约束限制：

不涉及。

取值范围：

  • zh-cn：中文。

  • en-us：英文。

默认取值：

zh-cn。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

status

String

参数解释：

响应状态。

取值范围：

  • success：成功。

  • error：失败。

result

Array of DisplayTrend objects

参数解释：

每次扫描的问题数和度量统计。

表4 DisplayTrend

参数

参数类型

描述

taskId

String

参数解释：

任务ID。

取值范围：

长度为[1~32]个字符。

snapshotId

Integer

参数解释：

度量快照ID。

取值范围：

不涉及。

totalLoc

Integer

参数解释：

有效代码行数，不包含空行和注释行。

取值范围：

不涉及。

criticalNum

Integer

参数解释：

致命问题数。

取值范围：

不涉及。

majorNum

Integer

参数解释：

严重问题数。

取值范围：

不涉及。

minorNum

Integer

参数解释：

一般问题数。

取值范围：

不涉及。

suggestionNum

Integer

参数解释：

提示问题数。

取值范围：

不涉及。

createTime

String

参数解释：

数据入库开始时间，使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。例如：2020-09-25T12:05:00Z。

取值范围：

不涉及。

endTime

String

参数解释：

数据入库结束时间，使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。例如：2020-09-25T12:05:00Z。

取值范围：

不涉及。

complexity

String

参数解释：

代码平均圈复杂度。

取值范围：

不涉及。

duplicationRate

String

参数解释：

代码重复率。

取值范围：

不涉及。

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

请求示例

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

GET https://{endpoint}/v1/history/defect-metric-trend?task_id=897acf5exxx48a5013cd&start_date=2025-06-01&end_date=2024-06-10

响应示例

状态码：200

查询问题和度量趋势响应体

{
  "status" : "success",
  "error" : null,
  "result" : [ {
    "taskId" : "45366a990xxx73be2a7a97f",
    "snapshotId" : 1,
    "openNum" : 37,
    "dismissingNum" : 0,
    "dismissedNum" : 0,
    "fixedNum" : 0,
    "totalLoc" : 636,
    "criticalNum" : 0,
    "majorNum" : 28,
    "minorNum" : 6,
    "suggestionNum" : 3,
    "informationNum" : 0,
    "createTime" : "2025-05-22T06:48:32Z",
    "endTime" : "2025-05-22T06:48:33Z",
    "delayNum" : 0,
    "density" : 58.1761,
    "complexity" : null,
    "duplicationRate" : 0
  } ]
}

状态码：400

Bad Request

{
  "error_code" : "CC.xxxxxxxx.400",
  "error_msg" : "请求参数校验失败,请检查请求参数是否正确"
}

状态码：401

Unauthorized

{
  "error_code" : "CC.00000003",
  "error_msg" : "认证信息过期"
}

状态码

状态码

描述

200

查询问题和度量趋势响应体

400

Bad Request

401

Unauthorized

错误码

请参见错误码。

父主题： 代码问题

相关文档