文档首页/ 代码检查 CodeArts Check/ API参考/ API/ 任务管理/ 查询分支任务列表
更新时间：2025-09-04 GMT+08:00
在线调试
CLI示例
查看PDF
分享

查询分支任务列表

功能介绍

查询分支任务列表

调用方法

请参见如何调用API。

URI

GET /v3/{project_id}/tasks/{task_id}/branches

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

项目ID，每个CodeArts首页下的项目都有1个唯一的项目ID

task_id

是

String

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

参数

是否必选

参数类型

描述

page_num

否

Integer

分页索引，非必填，默认值1，取值1-100

page_size

否

Integer

每页显示的数量，非必填，默认值10，取值1-100

check_type

否

String

查看任务类型，可选：branch、tag、mr、cr，默认为branch

offset

否

Integer

废弃参数，无业务意义，请勿使用

limit

否

Integer

废弃参数，无业务意义，请勿使用

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

响应参数

状态码：200 check_type: branch/tag

表4 响应Body参数

参数

参数类型

描述

branchTasks

Array of BranchTaskInfo objects

task_id对应任务树下已创建的分支、tag任务信息

total

Integer

总数
表5 BranchTaskInfo

参数

参数类型

描述

taskId

String

任务ID

branchName

String

任务名

isDefault

String

是否为默认分支

status

String

最近一次代码检查成功与否

状态码：200 check_type: mr/cr

表6 响应Body参数

参数

参数类型

描述

branchTasks

Array of IncTaskInfo objects

task_id对应任务下已创建的mr、cr任务信息

total

Integer

总数
表7 IncTaskInfo

参数

参数类型

描述

taskId

String

任务ID

mergeId

String

mr查询下为mr编号，cr查询下为git commit id

jobType

String

任务类型

status

String

检查成功与否

startTime

String

检查开始时间，UTC格式

finishTime

String

检查结束时间，UTC格式

mergeInfo

String

mr信息

jobId

String

执行ID

状态码：400

表8 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：401

表9 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

查询task_id对应任务下已创建的分支任务信息

GET https://{endpoint}/v3/{project_id}/tasks/{task_id}/branches

响应示例

状态码：200 check_type: branch/tag

Request succeeded!

{
  "branchTasks" : [ {
    "taskId" : "11223344xxxxxxxx11223344xxxxxxx1",
    "branchName" : "dev01",
    "isDefault" : "false",
    "status" : "failed"
  }, {
    "taskId" : "11223344xxxxxxxx11223344xxxxxxx2",
    "branchName" : "master",
    "isDefault" : "true",
    "status" : "success"
  } ],
  "total" : 6
}

状态码：200 check_type: mr/cr

Request succeeded!

{
  "branchTasks" : [ {
    "taskId" : "e6f59xxxx4fc46bcabfxxxxfa502fe56",
    "mergeId" : "2",
    "jobType" : "INC_GIT",
    "status" : "success",
    "startTime" : "2025-01-15T12:23:51Z",
    "finishTime" : "2025-01-15T12:25:06Z",
    "mergeInfo" : "test",
    "jobId" : "49e3bbxxxx8842819da744d9xxxx8478"
  } ],
  "total" : 23
}

状态码：400

Bad Request

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

状态码：401

Unauthorized

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

状态码

状态码

描述

200 check_type: branch/tag

Request succeeded!

200 check_type: mr/cr

Request succeeded!

400

Bad Request

401

Unauthorized

错误码

请参见错误码。

父主题： 任务管理

相关文档