文档首页/代码检查 CodeArts Check/API参考/API/代码问题/获取代码问题列表 - IssueListByFilter
更新时间：2025-12-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

获取代码问题列表 - IssueListByFilter

功能介绍

此API会根据参数中的筛选条件，返回符合条件的代码问题列表。

调用方法

请参见如何调用API。

授权信息

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

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

codeartscheck:task:getReport

Read

task *

-

-

-

-

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。即查询任务列表接口响应中的id字段。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

mergeId

否

String

参数解释：

合并请求ID。实际仅用于区分版本级和门禁级，版本级不传，门禁级传任意非空值即可。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

jobId

否

String

参数解释：

执行ID，来自代码检查执行任务接口的返回值，每次执行代码检查任务都有唯一的执行ID。版本级不传，门禁级必传。即“根据任务ID查询任务执行记录”的响应中的ID字段。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

pageSize

否

Integer

参数解释：

分页大小。

约束限制：

不涉及。

取值范围：

1-200

默认取值：

不涉及。

page

否

Integer

参数解释：

分页页码。

约束限制：

不涉及。

取值范围：

≥1

默认取值：

不涉及。

languages

否

String

参数解释：

编程语言。

约束限制：

不涉及。

取值范围：

  • PYTHON：PYTHON语言。

  • JAVA：JAVA语言。

  • C++：C++语言。

  • CSS：CSS语言。

  • PHP：PHP语言。

  • JAVASCRIPT：JAVASCRIPT语言。

  • GO：GO语言。

  • HTML：HTML语言。

  • C#：C#语言。

  • TYPESCRIPT：TYPESCRIPT语言。

  • SHELL：SHELL语言。

  • LUA：LUA语言。

  • RUST：RUST语言。

  • KOTLIN：KOTLIN语言。

  • SCALA：SCALA语言。

  • ARKTS：ARKTS语言。

  • SQL：SQL语言。

  • CANGJIE：CANGJIE语言。

默认取值：

不涉及。

ruleIds

否

String

参数解释：

规则ID。通过获取代码问题统计接口获取，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

参数解释：

代码问题列表。

表4 IssueListByFilter

参数

参数类型

描述

total

Integer

参数解释：

总数。

取值范围：

不涉及。

info

Array of Issue objects

参数解释：

代码问题。

表5 Issue

参数

参数类型

描述

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：PYTHON语言。

  • JAVA：JAVA语言。

  • C++：C++语言。

  • CSS：CSS语言。

  • PHP：PHP语言。

  • JAVASCRIPT：JAVASCRIPT语言。

  • GO：GO语言。

  • HTML：HTML语言。

  • C#：C#语言。

  • TYPESCRIPT：TYPESCRIPT语言。

  • SHELL：SHELL语言。

  • LUA：LUA语言。

  • RUST：RUST语言。

  • KOTLIN：KOTLIN语言。

  • SCALA：SCALA语言。

  • ARKTS：ARKTS语言。

  • SQL：SQL语言。

  • CANGJIE：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。

取值范围：

不涉及。

cwe

String

参数解释：

cwe编号。

取值范围：

不涉及。

statusComment

Array of Comment objects

参数解释：

问题操作历史。

fragment

Array of Fragment objects

参数解释：

问题代码片段信息。

versionRuleId

String

参数解释：

工具规则版本ID。

取值范围：

不涉及。

criterionVersionRuleId

String

参数解释：

规则版本ID。

取值范围：

不涉及。

ruleRuleId

String

参数解释：

工具规则唯一ID。

取值范围：

不涉及。

表6 Comment

参数

参数类型

描述

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

参数解释：

操作人。

取值范围：

不涉及。

statusFrom

String

参数解释：

问题起始状态。

取值范围：

不涉及。

statusTo

String

参数解释：

问题目标状态。

取值范围：

不涉及。

表7 Fragment

参数

参数类型

描述

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

Bad Request

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

状态码：401

Unauthorized

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

状态码

状态码

描述

200

代码问题列表响应体

400

Bad Request

401

Unauthorized

错误码

请参见错误码。

父主题： 代码问题

相关文档