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

更新代码问题状态 - UpdateIssueStatus

功能介绍

更新某个代码检查任务的某个代码问题状态，支持批量更新多个问题。

调用方法

请参见如何调用API。

授权信息

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

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

codeartscheck:task:updateReportStatus

Write

task *

-

-

-

-

codeartscheck:ProjectId

URI

POST /v1/defect/issue-status

请求参数

表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]个字符。

默认取值：

不涉及。

status

是

String

参数解释：

问题状态。

约束限制：

不涉及。

取值范围：

  • 0：待处理。

  • 2：已解决。

  • 5：已忽略。

默认取值：

不涉及。

comment

是

String

参数解释：

本次修改问题状态操作的备注。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

mergeKey

是

String

参数解释：

MergeKey，问题ID。获取代码问题列表响应中的mergeKey字段。

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

status

String

参数解释：

响应状态。

取值范围：

  • success：成功。

  • error：失败。

result

String

参数解释：

修改结果。

取值范围：

  • 修改成功：成功

  • null：失败

error

Error object

参数解释：

错误信息。只有失败时有，成功时没有。
表4 Error

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

reason

String

参数解释：

详细原因。

取值范围：

不涉及。

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

请求示例

将ID为897acf5exxx48a5013cd的任务下MergeKey为df16aacxxxf6c8758的问题状态修改为已忽略，并评论为‘工具误报’。

POST https://{endpoint}/v1/defect/issue-status

{
  "taskId" : "897acf5exxx48a5013cd",
  "mergeId" : "",
  "jobId" : "",
  "status" : 5,
  "comment" : "工具误报",
  "mergeKey" : "df16aacxxxf6c8758",
  "operator" : "devcloud_codecheck_01"
}

响应示例

状态码：200

更新代码问题状态响应体

{
  "status" : "success",
  "error" : null,
  "result" : "修改成功"
}

状态码：400

Bad Request

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

状态码：401

Unauthorized

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

状态码

状态码

描述

200

更新代码问题状态响应体

400

Bad Request

401

Unauthorized

错误码

请参见错误码。

父主题： 代码问题

相关文档