查询问题和度量趋势
功能介绍
查询指定时间内的每次扫描问题数量和度量指标趋势。
调用方法
请参见如何调用API。
URI
GET /v1/history/defect-metric-trend
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
task_id |
是 |
String |
参数解释： 任务ID，即新建检查任务接口的返回值，每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有1个唯一的任务ID。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
start_date |
是 |
String |
参数解释： 开始日期，使用UTC时间，格式为yyyy-MM-dd。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
end_date |
是 |
String |
参数解释： 结束日期，使用UTC时间，格式为yyyy-MM-dd。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
|
dimension |
是 |
String |
参数解释： 频次。 约束限制： times，每次扫描都展示。 取值范围： 不涉及。 默认取值： times |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Language |
否 |
String |
参数解释： 语言，决定响应以哪种语言返回。 约束限制： 不涉及。 取值范围：
默认取值： zh-cn |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
status |
String |
参数解释： 响应状态。 取值范围：
|
|
result |
Array of DisplayTrend objects |
参数解释： 每次扫描的问题数和度量统计。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
taskId |
String |
参数解释： 任务ID。 取值范围： 不涉及。 |
|
snapshotId |
Integer |
参数解释： 度量快照ID。 取值范围： 不涉及。 |
|
totalLoc |
Integer |
参数解释： 有效代码行数，不包含空行和注释行。 取值范围： 不涉及。 |
|
criticalNum |
Integer |
参数解释： 致命问题数。 取值范围： 不涉及。 |
|
majorNum |
Integer |
参数解释： 严重问题数。 取值范围： 不涉及。 |
|
minorNum |
Integer |
参数解释： 一般问题数。 取值范围： 不涉及。 |
|
suggestionNum |
Integer |
参数解释： 提示问题数。 取值范围： 不涉及。 |
|
createTime |
String |
参数解释： 数据入库开始时间，使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。 取值范围： 不涉及。 |
|
endTime |
String |
参数解释： 数据入库结束时间，使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。 取值范围： 不涉及。 |
|
complexity |
String |
参数解释： 代码平均圈复杂度。 取值范围： 不涉及。 |
|
duplicationRate |
String |
参数解释： 代码重复率。 取值范围： 不涉及。 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
错误码 |
|
error_msg |
String |
错误描述 |
状态码：401
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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.00000000",
"error_msg" : "网络繁忙，请稍后再试"
}
状态码：401
Unauthorized
{
"error_code" : "CC.00000003",
"error_msg" : "认证信息过期"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
查询问题和度量趋势响应体 |
|
400 |
Bad Request |
|
401 |
Unauthorized |
错误码
请参见错误码。
