查询缺陷详情的统计 - ShowTaskDefectsStatisticV2
功能介绍
根据检查任务ID查询代码检查问题的统计信息,包含各个问题状态、问题级别的数量统计。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| codeartscheck:task:getReport | Read | task * | - | - | - |
| - | codeartscheck:ProjectId |
URI
GET /v2/tasks/{task_id}/defects-statistic
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| task_id | 是 | String | 参数解释: 任务ID,即新建检查任务接口的返回值,每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即查询任务列表接口响应中的id字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Auth-Token | 是 | String | 参数解释: 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 长度为[1~100000]个字符。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| severity | StatisticSeverityV2 object | 参数解释: 各问题级别的问题数统计。 |
| status | StatisticStatusV2 object | 参数解释: 各问题状态的问题数统计。 |
| last_check_time | String | 参数解释: 检查开始时间,使用UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ。例如:2020-09-25T12:05:00Z。 取值范围: 不涉及。 |
| last_check_finish_time | String | 参数解释: 检查结束时间,使用UTC时间,格式为yyyy-MM-ddTHH:mm:ssZ。例如:2020-09-25T12:05:00Z。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| critical | Integer | 参数解释: 致命问题数。不包括已忽略和已修复问题。 取值范围: 不涉及。 |
| major | Integer | 参数解释: 严重问题数。不包括已忽略和已修复问题。 取值范围: 不涉及。 |
| minor | Integer | 参数解释: 一般问题数。不包括已忽略和已修复问题。 取值范围: 不涉及。 |
| suggestion | Integer | 参数解释: 提示问题数。不包括已忽略和已修复问题。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| unresolved | Integer | 参数解释: 待处理问题数。 取值范围: 不涉及。 |
| resolved | Integer | 参数解释: 已解决和已修复问题数。 取值范围: 不涉及。 |
| dismissed | Integer | 参数解释: 已忽略问题数。 取值范围: 不涉及。 |
| fixed | Integer | 参数解释: 已修复问题数。 取值范围: 不涉及。 |
| solved | Integer | 参数解释: 已解决问题数。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误描述。 取值范围: 不涉及。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误描述。 取值范围: 不涉及。 |
请求示例
查询ID为2b31ed520xxxxxxebedb6e57xxxxxxxx的任务问题详情的统计。
GET https://{endpoint}/v2/tasks/2b31ed520xxxxxxebedb6e57xxxxxxxx/defects-statistic 响应示例
状态码:200
Request succeeded!
{
"severity" : {
"critical" : 120,
"major" : 877,
"minor" : 79,
"suggestion" : 3
},
"status" : {
"unresolved" : 877,
"resolved" : 79,
"dismissed" : 5,
"fixed" : 70,
"solved" : 9
}
} 状态码:400
Bad Request
{
"error_code" : "CC.xxxxxxxx.400",
"error_msg" : "请求参数校验失败,请检查请求参数是否正确"
} 状态码:401
Unauthorized
{
"error_code" : "CC.00000003",
"error_msg" : "认证信息过期"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | Request succeeded! |
| 400 | Bad Request |
| 401 | Unauthorized |
错误码
请参见错误码。