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

查询任务列表

功能介绍

根据project_id查询该项目下的任务列表。

调用方法

请参见如何调用API。

URI

GET /v2/{project_id}/tasks

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：

项目的32位uuid，项目唯一标识，通过查询项目列表接口查询项目列表获取。

约束限制：

不涉及。

取值范围：

32位项目ID。

默认取值：

不涉及。
表2 Query参数

参数

是否必选

参数类型

描述

offset

否

Integer

参数解释：

页码，类似page_num的作用。

约束限制：

不涉及。

取值范围：

0-999999

limit

否

Integer

参数解释：

每页数量，类似page_size的作用。

约束限制：

不涉及。

取值范围：

1-100

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

字符串长度不少于1，不超过10万。

默认取值：

不涉及。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

tasks

Array of SimpleTaskInfoV2 objects

参数解释：

任务信息。

取值范围：

不涉及。

total

Integer

参数解释：

项目下的任务总数。

取值范围：

不涉及。
表5 SimpleTaskInfoV2

参数

参数类型

描述

task_id

String

参数解释：

任务下的默认分支任务的id。

取值范围：

不涉及。

task_name

String

参数解释：

任务名称。

取值范围：

不涉及。

creator_id

String

参数解释：

任务创建者的用户id。

取值范围：

不涉及。

git_url

String

参数解释：

代码仓地址。

取值范围：

不涉及。

git_branch

String

参数解释：

任务的默认分支，非代码仓默认分支。

取值范围：

不涉及。

created_at

String

参数解释：

任务创建时间。

取值范围：

UTC格式。

last_check_time

String

参数解释：

任务下所有分支任务、增量任务的最近检查时间。

取值范围：

UTC格式。

状态码：400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：401

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

GET https://{endpoint}/v2/{task_id}/tasks

响应示例

状态码：200

Request succeeded!

{
  "tasks" : [ {
    "task_id" : "435b58e********d01c94a6",
    "task_name" : "CSharp_02201119",
    "creator_id" : "ecadebb5041***9780f3d905e20",
    "git_url" : "git@********_02201119.git",
    "git_branch" : "master",
    "created_at" : "2020-02-20 11:21:11",
    "last_check_time" : "2020-02-20 11:37:46"
  }, {
    "task_id" : "435b58343tg5g36907c1384d01c94a6",
    "task_name" : "CSharp_066",
    "creator_id" : "ecadebb3664*****",
    "git_url" : "git@****_02201119.git",
    "git_branch" : "master",
    "created_at" : "2020-02-20 11:21:11",
    "last_check_time" : "2020-02-20 11:37:46"
  } ],
  "total" : 2
}

状态码：400

Bad Request

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

状态码：401

Unauthorized

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

状态码

状态码

描述

200

Request succeeded!

400

Bad Request

401

Unauthorized

错误码

请参见错误码。

父主题： 任务管理