# 获取代码问题列表 - IssueListByFilter #### 功能介绍 此API会根据参数中的筛选条件，返回符合条件的代码问题列表。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-codecheck/codecheck_03_0006.html)。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-codecheck/Permission.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | codeartscheck:task:getReport | Read | task \* | - | - | - | | codeartscheck:task:getReport | Read | - | codeartscheck:ProjectId | - | - | #### URI POST /v1/defect/issue-list-by-filter #### 请求参数 表1请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Language | 否 | String | **参数解释：** 语言，决定响应以哪种语言返回。 **约束限制：** 不涉及。 **取值范围：** - zh-cn：中文。 - en-us：英文。 **默认取值：** zh-cn。 | 表2请求Body参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | taskId | 是 | String | **参数解释：** 任务ID，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即[查询任务列表](https://support.huaweicloud.com/api-codecheck/ShowTasksList.html)接口响应中的id字段。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~32\]个字符。 **默认取值：** 不涉及。 | | mergeId | 否 | String | **参数解释：** 合并请求ID。实际仅用于区分版本级和门禁级，版本级不传，门禁级传任意非空值即可。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | jobId | 否 | String | **参数解释：** 执行ID，来自代码检查执行任务接口的返回值，每次执行代码检查任务都有唯一的执行ID。版本级不传，门禁级必传。即"根据任务ID查询任务执行记录"的响应中的ID字段。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~32\]个字符。 **默认取值：** 不涉及。 | | pageSize | 否 | Integer | **参数解释：** 分页大小。 **约束限制：** 不涉及。 **取值范围：** 1-200 **默认取值：** 10 | | page | 否 | Integer | **参数解释：** 分页页码。 **约束限制：** 不涉及。 **取值范围：** ≥1 **默认取值：** 不涉及。 | | languages | 否 | String | **参数解释：** 编程语言。 **约束限制：** 不涉及。 **取值范围：** - PYTHON - JAVA - C++ - CSS - PHP - JAVASCRIPT - GO - HTML - C# - TYPESCRIPT - SHELL - LUA - RUST - KOTLIN - SCALA - ARKTS - SQL - CANGJIE **默认取值：** 不涉及。 | | ruleIds | 否 | String | **参数解释：** 规则ID。通过[获取代码问题统计](https://support.huaweicloud.com/api-codecheck/IssueFilter.html)接口获取，facets参数传入ruleIds，在响应体Facet.property=ruleIds时取FacetItem.val即规则ID。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | authors | 否 | String | **参数解释：** 问题负责人的用户名。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | isNew | 否 | String | **参数解释：** 是否新问题。 **约束限制：** 不涉及。 **取值范围：** - 0：所有问题，包含新问题。 - 1：新问题。 **默认取值：** 不涉及。 | | statusIds | 否 | String | **参数解释：** 问题状态。 **约束限制：** 不涉及。 **取值范围：** - 0：待处理。 - 2：已解决。 - 5：已忽略。 - 6：已修复。 **默认取值：** 不涉及。 | | severities | 否 | String | **参数解释：** 问题级别。 **约束限制：** 不涉及。 **取值范围：** - 0：致命。 - 1：严重。 - 2：一般。 - 3：提示。 **默认取值：** 不涉及。 | | delayStatus | 否 | String | **参数解释：** 延迟状态。 **约束限制：** 不涉及。 **取值范围：** - 0：正式。 - 1：延迟上线。 **默认取值：** 不涉及。 | | fileNames | 否 | String | **参数解释：** 文件名，精准匹配。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | userTags | 否 | Array of strings | **参数解释：** 标签。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | cwes | 否 | Array of strings | **参数解释：** CWE编号。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | status | String | **参数解释：** 响应状态。 **取值范围：** - success：成功。 - error：失败。 | | result | Array of [IssueListByFilter] objects | **参数解释：** 代码问题列表。 | 表4IssueListByFilter | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | **参数解释：** 代码问题列表总数。 **取值范围：** 不涉及。 | | info | Array of [Issue] objects | **参数解释：** 代码问题。 | 表5Issue | 参数 | 参数类型 | 描述 | |:---|:---|:---| | defectLevel | String | **参数解释：** 问题级别。 **取值范围：** - 0：致命。 - 1：严重。 - 2：一般。 - 3：提示。 | | defectStatus | String | **参数解释：** 问题状态。 **取值范围：** - 0：待处理。 - 2：已解决。 - 5：已忽略。 - 6：已修复。 | | checkerName | String | **参数解释：** 检查引擎。 **取值范围：** 不涉及。 | | defectType | String | **参数解释：** 工具规则名称。 **取值范围：** 不涉及。 | | fileName | String | **参数解释：** 代码文件名。 **取值范围：** 不涉及。 | | filePath | String | **参数解释：** 文件路径。 **取值范围：** 不涉及。 | | ruleId | String | **参数解释：** 规则唯一ID。 **取值范围：** 不涉及。 | | author | String | **参数解释：** 责任人。 **取值范围：** 不涉及。 | | createdAt | String | **参数解释：** 问题发现时间，使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。例如：2020-09-25T12:05:00Z。 **取值范围：** 不涉及。 | | criterionName | String | **参数解释：** 规则名称。 **取值范围：** 不涉及。 | | ruleLanguage | String | **参数解释：** 编程语言。 **取值范围：** - PYTHON - JAVA - C++ - CSS - PHP - JAVASCRIPT - GO - HTML - C# - TYPESCRIPT - SHELL - LUA - RUST - KOTLIN - SCALA - ARKTS - SQL - CANGJIE | | mergeKey | String | **参数解释：** MergeKey，问题ID。 **取值范围：** 长度为\[1\~32\]个字符。 | | functionName | String | **参数解释：** 函数名称。 **取值范围：** 不涉及。 | | isNew | String | **参数解释：** 是否新问题。 **取值范围：** - 0：所有问题，包含新问题。 - 1：新问题。 | | delayStatus | String | **参数解释：** 延迟状态。 **取值范围：** - 0：正式。 - 1：延迟上线。 | | criterionType | String | **参数解释：** 规则类型。 **取值范围：** 不涉及。 | | delayStartTime | String | **参数解释：** 延迟开始时间，使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。例如：2020-09-25T12:05:00Z。 **取值范围：** 不涉及。 | | delayEndTime | String | **参数解释：** 延迟结束时间，使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。例如：2020-09-25T12:05:00Z。 **取值范围：** 不涉及。 | | approver | String | **参数解释：** 废弃字段。 **取值范围：** 不涉及。 | | cwe | String | **参数解释：** cwe编号。 **取值范围：** 不涉及。 | | statusComment | Array of [Comment] objects | **参数解释：** 问题操作历史。 | | fragment | Array of [Fragment] objects | **参数解释：** 问题代码片段信息。 | | versionRuleId | String | **参数解释：** 工具规则版本ID。 **取值范围：** 不涉及。 | | criterionVersionRuleId | String | **参数解释：** 规则版本ID。 **取值范围：** 不涉及。 | | ruleRuleId | String | **参数解释：** 工具规则唯一ID。 **取值范围：** 不涉及。 | | issueId | String | **参数解释：** 问题单ID。用户可以在代码问题页面针对某个代码问题创建问题单。 **取值范围：** 不涉及。 | | category | String | **参数解释：** 规则类别。 **取值范围：** 不涉及。 | | subcategory | String | **参数解释：** 废弃字段。 **取值范围：** 不涉及。 | 表6Comment | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | Integer | **参数解释：** 操作历史ID。 **取值范围：** 不涉及。 | | comments | String | **参数解释：** 备注。 **取值范围：** 长度为\[1\~256\]个字符。 | | mergeKey | String | **参数解释：** MergeKey，问题ID。 **取值范围：** 长度为\[1\~32\]个字符。 | | createTime | String | **参数解释：** 发生时间，使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。例如：2020-09-25T12:05:00Z。 **取值范围：** 不涉及。 | | applicant | String | **参数解释：** 申请人。 **取值范围：** 不涉及。 | | approver | String | **参数解释：** 废弃字段。 **取值范围：** 不涉及。 | | statusFrom | String | **参数解释：** 问题起始状态。 **取值范围：** - 0：待处理。 - 2：已解决。 - 5：已忽略。 - 6：已修复。 | | statusTo | String | **参数解释：** 问题目标状态。 **取值范围：** - 0：待处理。 - 2：已解决。 - 5：已忽略。 - 6：已修复。 | | ignoreType | String | **参数解释：** 废弃字段。 **取值范围：** - NO_RISK：评估无风险暂不解决。 - FALSE_POSITIVES：纯属工具误报。 - THIRD_PARTY：开源及第三方。 - EFFUCUENCY_RETAIN：性能敏感保留危险函数。 - NO_SUPPORT_INKERNEL：不支持的内核危险函数。 - EXCLUDE_SCENES：规范例外场景。 - COMPATIBLE_THIRD_PARTY：兼容第三方。 | 表7Fragment | 参数 | 参数类型 | 描述 | |:---|:---|:---| | bugId | String | **参数解释：** 问题代码片段ID。 **取值范围：** 不涉及。 | | lineNum | String | **参数解释：** 问题所在行号。 **取值范围：** 不涉及。 | | lineContent | String | **参数解释：** 问题所在行代码内容。 **取值范围：** 不涉及。 | | filePath | String | **参数解释：** 文件路径。 **取值范围：** 不涉及。 | | description | String | **参数解释：** 问题描述。 **取值范围：** 不涉及。 | | codeContextStartLine | String | **参数解释：** 代码上下文起始行号。 **取值范围：** 不涉及。 | | codeContext | String | **参数解释：** 代码上下文。 **取值范围：** 不涉及。 | | events | String | **参数解释：** 调用链信息。 **取值范围：** 不涉及。 | **状态码：400** 表8响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | **状态码：401** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | error_code | String | **参数解释：** 错误码。 **取值范围：** 不涉及。 | | error_msg | String | **参数解释：** 错误描述。 **取值范围：** 不涉及。 | #### 请求示例 查询ID为897acf5exxx48a5013cd的任务最新一次版本级扫描的问题列表。筛选条件为：问题状态为待处理、已解决，问题级别为严重，问题延迟状态为正式问题。在此筛选条件下分页查询，每页100条，第1页。 ``` POST https://{endpoint}/v1/defect/issue-list-by-filter { "taskId" : "897acf5exxx48a5013cd", "jobId" : "", "mergeId" : "", "statusIds" : "0,2", "severities" : "1", "delayStatus" : "0", "isNew" : "", "languages" : "", "authors" : "", "fileNames" : "", "ruleIds" : "", "page" : 1, "pageSize" : 10 } ``` #### 响应示例 **状态码：200** 代码问题列表响应体 ``` { "status" : "success", "error" : null, "result" : [ { "total" : "87", "info" : [ { "defectLevel" : "2", "issueId" : null, "defectStatus" : "0", "checkerName" : "apiengine", "defectType" : "API_DOC_STRUCT_03", "fileName" : "API_DOC_STRUCT_03.d.ts", "filePath" : "API_DOC_STRUCT_03.d.ts", "modulePath" : null, "moduleID" : "-1", "ruleId" : "10ccf00e72094ab99e53418fa74b1859", "author" : "test_user", "createdAt" : "2024-08-02T07:00:35Z", "nickName" : "test_user", "criterionName" : "API.DOC.STRUCT.03 @struct标签使用不合理", "ruleLanguage" : "TYPESCRIPT", "owner" : null, "mergeKey" : "15ab8c7ee14cf18a559f166f9219998e", "functionName" : "", "isNew" : "0", "delayStatus" : "0", "isHit" : null, "criterionType" : "common", "delayStartTime" : null, "delayEndTime" : null, "approver" : "", "ruleUrl" : "", "cwe" : null, "statusComment" : [ ], "fragment" : [ { "bugId" : "a47506a9-7260-48e4-9c0c-f59783957b6c", "lineNum" : "29", "lineContent" : "export declare enum GridObjectSortComponentType", "filePath" : "API_DOC_STRUCT_03.d.ts", "description" : "API check error of [wrong scene]: JSDoc label validity verification failed. The [struct] label is not allowed. Please check the label usage method.", "codeContextStartLine" : 24, "codeContext" : " * @enum { string }\n * @syscap SystemCapability.ArkUI.ArkUI.Full\n * @crossplatform\n * @since 11\n */\nexport declare enum GridObjectSortComponentType {}", "engine" : "", "category" : "", "subcategory" : "", "events" : "[{\"description\":\"API check error of [wrong scene]: JSDoc label validity verification failed. The [struct] label is not allowed. Please check the label usage method.\",\"fixSuggestion\":[],\"line\":29,\"main\":true,\"path\":\"API_DOC_STRUCT_03.d.ts\",\"mainBuggyCode\":\"export declare enum GridObjectSortComponentType\",\"codeContext\":\" * @enum { string }\\n * @syscap SystemCapability.ArkUI.ArkUI.Full\\n * @crossplatform\\n * @since 11\\n */\\nexport declare enum GridObjectSortComponentType {}\",\"codeContextStartLine\":24,\"codePassage\":[],\"events\":[],\"isContextShow\":false}]", "extendInfo" : null } ], "versionRuleId" : "11ef44b094c732d0a5de99700335f1a8", "criterionVersionRuleId" : "10ccf00e72094ab99e53418fa74b1859", "codeUrl" : null, "ruleRuleId" : "11ef44b094c732d0a5de99700335f1a8" } ] } ] } ``` **状态码：400** 请求异常。 ``` { "error_code" : "CC.xxxxxxxx.400", "error_msg" : "请求参数校验失败,请检查请求参数是否正确" } ``` **状态码：401** 权限不足。 ``` { "error_code" : "CC.00000003", "error_msg" : "认证信息过期" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 代码问题列表响应体 | | 400 | 请求异常。 | | 401 | 权限不足。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-codecheck/ErrorCode.html)。