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

查询模板任务列表

功能介绍

web查询模板任务列表

调用方法

请参见如何调用API。

URI

GET /v4/template-tasks

表1 Query参数

参数

是否必选

参数类型

描述

project_id

否

String

参数解释：

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

约束条件：

不涉及。

取值范围：

字符串长度32。

默认取值：

不涉及。

page

否

Integer

参数解释：

分页编号，从0开始。

约束限制：

不涉及

取值范围：

0-999999

默认取值：

0

page_size

否

Integer

参数解释：

分页大小。

约束限制：

不涉及

取值范围：

数字1-200之间

默认取值：

10

search

否

String

参数解释：

按模板名称模糊搜索。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

响应参数

状态码：200

表3 响应Body参数

参数

参数类型

描述

total

Integer

参数解释：

模板任务总数。

取值范围：

大于等于0。

data

Array of TemplateTask objects

参数解释：

模板任务列表。

取值范围：

不涉及。
表4 TemplateTask

参数

参数类型

描述

id

String

参数解释：

模板任务的id。

取值范围：

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

taskGroupId

String

参数解释：

任务分组的id。

取值范围：

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

name

String

参数解释：

模板任务的名称。

取值范围：

不涉及。

projectId

String

参数解释：

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

取值范围：

字符串长度32。

createTime

String

参数解释：

创建时间。

取值范围：

不涉及。

taskId

String

参数解释：

任务的id。

取值范围：

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

repoUrl

String

参数解释：

代码仓地址。

取值范围：

不涉及。

branchName

String

参数解释：

分支名称。

取值范围：

不涉及。

owner

String

参数解释：

任务创建者。

取值范围：

不涉及。

canRead

Boolean

参数解释：

是否有读的权限。

取值范围：

true：有，false：没有。

canCreate

Boolean

参数解释：

是否有创建的权限。

取值范围：

true：有，false：没有。

canExecute

Boolean

参数解释：

是否有执行的权限。

取值范围：

true：有，false：没有。

canEdit

Boolean

参数解释：

是否有编辑的权限。

取值范围：

true：有，false：没有。

canDelete

Boolean

参数解释：

是否有删除的权限。

取值范围：

true：有，false：没有。

isTenantTemplate

AnyType

参数解释：

是否是租户级模板任务。

取值范围：

true：是，false：否。

tenantId

String

参数解释：

租户id。

取值范围：

字符串长度32。

region

String

参数解释：

逻辑区域。

取值范围：

不涉及。

状态码：400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码：401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

查询模板任务列表

GET https://{endpoint}/v4/template-tasks?project_id=40a381e7abf944bdbc5d6865xxxxxxxx&search=&page=1&page_size=15&

响应示例

状态码：200

Request succeeded!

{
  "data" : [ {
    "id" : "9e4b0cb2277846c8b10d2c29xxxxxxxx",
    "taskGroupId" : "07eddd84b77840efaca31ab6xxxxxxxx",
    "name" : "test",
    "projectId" : "f901ace2088248e1ae697b87xxxxxxxx",
    "createTime" : "2025-05-12T11:43:41Z",
    "taskId" : "da620b68a93c4891bd005810xxxxxxxx",
    "repoUrl" : "https://gitcode.com/sharonxxxx/JeecgBoot.git",
    "branchName" : "master",
    "owner" : "devcloud_codecheck_l00493925_01",
    "canRead" : true,
    "canCreate" : false,
    "canExecute" : false,
    "canEdit" : false,
    "canDelete" : false,
    "isTenantTemplate" : 1,
    "tenantId" : null,
    "region" : null
  }, {
    "id" : "2f56cfda900c4bc4b16de725xxxxxxxx",
    "taskGroupId" : "07eddd84b77840efaca31ab6xxxxxxxx",
    "name" : "test2",
    "projectId" : "f901ace2088248e1ae697b87xxxxxxxx",
    "createTime" : "2025-05-12T10:05:52Z",
    "taskId" : "3965cece9cb040c3a6ff2e68xxxxxxxx",
    "repoUrl" : "git@codehub.devcloud.{region}-7.huawei.com:c5456550c62649f9bb018d20xxxxxxxx/test.git",
    "branchName" : "master",
    "owner" : "devcloud_codecheck_l00493925_02",
    "canRead" : true,
    "canCreate" : false,
    "canExecute" : false,
    "canEdit" : false,
    "canDelete" : false,
    "isTenantTemplate" : 1,
    "tenantId" : null,
    "region" : null
  } ],
  "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

错误码

请参见错误码。

父主题： 任务管理

相关文档