查询代码问题概览 - GetTaskStatistics
功能介绍
查询版本级或门禁级扫描的代码问题概览。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型（*为必须） | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| codeartscheck:task:getReport | Read | task * | - | - | - |
| - | codeartscheck:ProjectId |
URI
GET /v1/defects/task-statistics
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| task_id | 是 | String | 参数解释： 任务ID，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即查询任务列表接口响应中的id字段。 约束限制： 不涉及。 取值范围： 长度为[1~32]个字符。 默认取值： 不涉及。 |
| merge_id | 否 | String | 参数解释： 合并请求ID或Commit ID，主要用于查询门禁级任务。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
| job_id | 否 | String | 参数解释： 执行记录ID，即每一次执行版本级或门禁级扫描的唯一ID，主要用于查询门禁级任务。 约束限制： 不涉及。 取值范围： 不涉及。 默认取值： 不涉及。 |
请求参数
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释： 响应状态。 取值范围： |
| result | Array of GetTaskStatistics objects | 参数解释： 代码问题概览。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| property | String | 参数解释： 维度。 取值范围： |
| values | Array of GetTaskStatisticsFacetItem objects | 参数解释： 维度下不同分类的概览。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| val | String | 参数解释： 维度下的分类，可能是问题状态、问题级别、责任人或其他分类值。 取值范围： 不涉及。 |
| count | String | 参数解释： 数量。 取值范围： 不涉及。 |
状态码：400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释： 错误码。 取值范围： 不涉及。 |
| error_msg | String | 参数解释： 错误描述。 取值范围： 不涉及。 |
状态码：401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释： 错误码。 取值范围： 不涉及。 |
| error_msg | String | 参数解释： 错误描述。 取值范围： 不涉及。 |
请求示例
查询ID为897acf5exxx48a5013cd的任务最新一次版本级扫描的代码问题概览。
GET https://{endpoint}/v1/defects/task-statistics?task_id=897acf5exxx48a5013cd 响应示例
状态码：200
查询代码问题概览响应体
{
"result" : {
"facets" : [ {
"values" : [ {
"val" : "0",
"count" : "9"
}, {
"val" : "1",
"count" : "0"
}, {
"val" : "2",
"count" : "0"
}, {
"val" : "3",
"count" : "0"
}, {
"val" : "4",
"count" : "0"
}, {
"val" : "5",
"count" : "0"
}, {
"val" : "6",
"count" : "0"
} ],
"property" : "statuses"
}, {
"values" : [ {
"val" : "0",
"count" : "0"
}, {
"val" : "1",
"count" : "9"
}, {
"val" : "2",
"count" : "0"
}, {
"val" : "3",
"count" : "0"
} ],
"property" : "severities"
}, {
"values" : [ {
"val" : "devcloud_codecheck_l00493925_01",
"count" : "9",
"nickName" : "devcloud_codecheck_l00493925_01"
} ],
"property" : "authors"
}, {
"values" : [ {
"val" : "new",
"count" : "0"
} ],
"property" : "isNew"
}, {
"values" : [ {
"val" : "G.EXP.01-CPP 不要声明或定义保留标识符",
"id" : "10111f7b6d6511edab16fa163e0fa374",
"count" : "5"
}, {
"val" : "G.PRE.04-CPP \\#if 或 \\#elif 预处理指令中的常量表达式被求值前应确保其使用的标识符已定义",
"id" : "621f02e784f511edafd1fa163ef7e846",
"count" : "3"
}, {
"val" : "G.CNS.02-CPP 不要使用难以理解的字面量",
"id" : "fd1a79f46d6411edab16fa163e0fa374",
"count" : "1"
} ],
"property" : "rules"
}, {
"values" : [ {
"val" : "0",
"count" : "9"
}, {
"val" : "1",
"count" : "0"
} ],
"property" : "delayStatus"
}, {
"values" : [ {
"val" : "unresolvedAdd",
"count" : "0"
} ],
"property" : "unresolvedAdd"
}, {
"values" : [ {
"val" : "0",
"count" : "0"
}, {
"val" : "1",
"count" : "9"
}, {
"val" : "2",
"count" : "0"
}, {
"val" : "3",
"count" : "0"
} ],
"property" : "severitiesUnresolved"
}, {
"values" : [ {
"val" : "0",
"count" : "0"
}, {
"val" : "1",
"count" : "0"
}, {
"val" : "2",
"count" : "0"
}, {
"val" : "3",
"count" : "0"
} ],
"property" : "severitiesNew"
} ]
},
"status" : "success"
} 状态码：400
Bad Request
{
"error_code" : "CC.xxxxxxxx.400",
"error_msg" : "请求参数校验失败,请检查请求参数是否正确"
} 状态码：401
Unauthorized
{
"error_code" : "CC.00000003",
"error_msg" : "认证信息过期"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 查询代码问题概览响应体 |
| 400 | Bad Request |
| 401 | Unauthorized |
错误码
请参见错误码。
