# 查询模板任务列表 - ShowTemplateTasks #### 功能介绍 根据项目ID和需要搜索的模板任务名称分页查询项目下的模板任务，返回模板任务的模板任务ID、模板任务名、代码仓地址和分支名等信息。 #### 调用方法 请参见[如何调用API](https://support.huaweicloud.com/api-codecheck/codecheck_03_0006.html)。 #### 授权信息 账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见[权限和授权项](https://support.huaweicloud.com/api-codecheck/Permission.html)。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | codeartscheck:task:list | List | task \* | - | - | - | | codeartscheck:task:list | List | - | codeartscheck:ProjectId | - | - | #### URI GET /v4/template-tasks 表1Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 否 | String | **参数解释：** 项目的32位UUID，项目唯一标识，通过[查询项目列表](https://support.huaweicloud.com/api-projectman/ListProjectsV4.html)接口获取。 **约束条件：** 不涉及。 **取值范围：** 长度为\[1\~32\]个字符。 **默认取值：** 不涉及。 | | page | 否 | Integer | **参数解释：** 分页编号，从0开始。 **约束限制：** 不涉及。 **取值范围：** 0\~2147483647 **默认取值：** 0 | | page_size | 否 | Integer | **参数解释：** 分页大小。 **约束限制：** 不涉及。 **取值范围：** 1-200 **默认取值：** 10 | | search | 否 | String | **参数解释：** 按模板名称模糊搜索。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | #### 请求参数 表2请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。通过调用IAM服务[获取用户Token](https://support.huaweicloud.com/api-iam/iam_30_0001.html)接口获取（响应消息头中X-Subject-Token的值）。 **约束限制：** 不涉及。 **取值范围：** 长度为\[1\~100000\]的字符。 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表3响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | **参数解释：** 模板任务总数。 **取值范围：** ≥0 | | data | Array of [TemplateTask] objects | **参数解释：** 模板任务列表。 | 表4TemplateTask | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 模板任务的ID。 **取值范围：** 长度为\[1\~128\]个字符。 | | taskGroupId | String | **参数解释：** 任务分组的ID。 **取值范围：** 长度为\[1\~128\]个字符。 | | name | String | **参数解释：** 模板任务的名称。 **取值范围：** 不涉及。 | | projectId | String | **参数解释：** 项目的32位UUID，项目唯一标识，通过[查询项目列表](https://support.huaweicloud.com/api-projectman/ListProjectsV4.html)接口获取。 **取值范围：** 长度为\[1\~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。 **取值范围：** 长度为\[1\~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** 请求成功! ``` { "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_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.example.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** 请求异常。 ``` { "error_code" : "CC.xxxxxxxx.400", "error_msg" : "请求参数校验失败,请检查请求参数是否正确" } ``` **状态码：401** 权限不足。 ``` { "error_code" : "CC.00000003", "error_msg" : "认证信息过期" } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 请求成功! | | 400 | 请求异常。 | | 401 | 权限不足。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-codecheck/ErrorCode.html)。