文档首页/ 代码检查 CodeArts Check/ API参考/ API/ 代码问题/ 查询单个问题详情和上下文代码 - GetSingleDefect
更新时间：2025-12-09 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询单个问题详情和上下文代码 - GetSingleDefect

功能介绍

根据MergeKey查询某个问题的详细信息及上下文代码

调用方法

请参见如何调用API。

授权信息

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

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

codeartscheck:task:getReport

Read

task *

-

-

-

-

codeartscheck:ProjectId

URI

GET /v1/defect

表1 Query参数

参数

是否必选

参数类型

描述

task_id

是

String

参数解释：

任务ID，即新建检查任务接口的返回值，每个CodeArtsCheck任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

merge_id

否

String

参数解释：

合并请求ID或Commit ID，主要用于查询门禁级任务。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

job_id

否

String

参数解释：

执行记录ID，即每一次执行版本级或门禁级扫描的唯一ID，主要用于查询门禁级任务。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

merge_key

是

String

参数解释：

MergeKey，问题ID。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Language

否

String

参数解释：

语言，决定响应以哪种语言返回。

约束限制：

不涉及。

取值范围：

  • zh-cn，中文。

  • en-us，英文。

默认取值：

zh-cn。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

result

String

参数解释：

单个问题详情及上下文。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

状态码：400

表4 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：401

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

查询ID为897acf5exxx48a5013cd的版本级任务下，MergeKey为08abe0dcxxx817d18e189的问题的详情及上下文

GET https://{endpoint}/v1/defects?task_id=897acf5exxx48a5013cd&merge_key=08abe0dcxxx817d18e189

响应示例

状态码：400

Bad Request

{
  "error_code" : "CC.00000000",
  "error_msg" : "网络繁忙，请稍后再试"
}

状态码：401

Unauthorized

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

状态码

状态码

描述

200

问题的详细信息及上下文代码

400

Bad Request

401

Unauthorized

错误码

请参见错误码。

父主题： 代码问题

相关文档