文档首页/代码检查 CodeArts Check/API参考/API/任务管理/根据任务类型获取检查列表 - ShowCheckList
更新时间：2025-12-30 GMT+08:00
在线调试
CLI示例
查看PDF
分享

根据任务类型获取检查列表 - ShowCheckList

功能介绍

根据任务ID和任务类型分页查询任务列表，可通过此接口查询任务下的分支任务、Tag任务、Mr任务和Commit任务。

调用方法

请参见如何调用API。

授权信息

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

授权项

访问级别

资源类型（*为必须）

条件键

别名

依赖的授权项

codeartscheck:task:get

Read

task *

-

-

-

-

codeartscheck:ProjectId

URI

GET /v4/task/{task_id}/check-list

表1 路径参数

参数

是否必选

参数类型

描述

task_id

是

String

参数解释：

任务ID，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即查询任务列表接口响应中的id字段。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

表2 Query参数

参数

是否必选

参数类型

描述

check_type

否

String

参数解释：

任务类型。

约束限制：

不涉及。

取值范围：

  • branch：分支任务。

  • tag：Tag任务。

  • cr：Change Request任务。

  • mr：Merge Request任务。

默认取值：

branch。

page

是

Integer

参数解释：

分页页码。

约束限制：

不涉及。

取值范围:

1-2147483647

默认取值：

不涉及。

page_size

是

Integer

参数解释：

分页大小。

约束限制：

不涉及。

取值范围：

1-200

默认取值：

200

search

否

String

参数解释：

搜索关键字。

约束限制：

check_type为branch时支持搜索分支名；

check_type为tag时支持搜索tag名；

check_type为cr或mr时不支持搜索。

取值范围：

不涉及。

默认取值：

不涉及。

time_start

否

String

参数解释：

检查开始时间的起点。使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。例如：2020-09-25T12:05:00Z。

约束限制：

check_type为branch或tag时不支持时间过滤；

check_type为cr或mr时支持时间过滤。

取值范围：

不涉及。

默认取值：

不涉及。

time_end

否

String

参数解释：

检查开始时间的终点。使用UTC时间，格式为yyyy-MM-ddTHH:mm:ssZ。例如：2020-09-25T12:05:00Z。

约束限制：

check_type为branch或tag时不支持时间过滤；

check_type为cr或mr时支持时间过滤。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

无

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

result

CheckListResult object

参数解释：

获取检查列表的响应结果。

取值范围：

不涉及。

表4 CheckListResult

参数

参数类型

描述

total

Integer

参数解释:

检查列表的总数。

取值范围:

≥0

list

Array of CheckResultInfo objects

参数解释：

检查详情。

取值范围：

不涉及。

表5 CheckResultInfo

参数

参数类型

描述

taskId

String

参数解释:

任务ID，即新建检查任务接口的返回值，每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即查询任务列表接口响应中的id字段。

取值范围:

字符串长度＞0。

branchName

String

参数解释:

分支名。

取值范围:

字符串长度＞0。

isDefault

Boolean

参数解释:

是否是默认分支。

取值范围:

true、false。

status

String

参数解释:

任务执行状态。

取值范围:

  • quering：初始状态。

  • running：执行中。

  • success：检查成功。

  • failed：检查失败。

  • aborted：任务中止。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

取值范围：

不涉及。

error_msg

String

参数解释：

错误描述。

取值范围：

不涉及。

请求示例

查询任务ID为aeuxxlgh，分支为master的分支检查记录，分页为第1页，分页大小是每页10个。

GET https://{endpoint}/v4/task/aeuxxlgh/check-list?check_type=branch&page=1&page_size=10&search=master

响应示例

状态码：200

Request succeeded!

{
  "result" : {
    "total" : 3,
    "list" : [ {
      "taskId" : null,
      "branchName" : "dev",
      "isDefault" : false,
      "status" : null
    }, {
      "taskId" : "63f5fb89cc9a4855967947935b74cd61",
      "branchName" : "master",
      "isDefault" : true,
      "status" : "success"
    }, {
      "taskId" : null,
      "branchName" : "test",
      "isDefault" : false,
      "status" : null
    } ]
  }
}

状态码：400

Bad Request

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

状态码：401

Unauthorized

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

状态码

状态码

描述

200

Request succeeded!

400

Bad Request

401

Unauthorized

错误码

请参见错误码。

父主题： 任务管理

相关文档