文档首页/ 代码检查 CodeArts Check/ API参考/ API/ 任务管理/ 列出项目下的分组信息
更新时间:2025-09-04 GMT+08:00
分享

列出项目下的分组信息

功能介绍

列出项目下的分组信息。

调用方法

请参见如何调用API

URI

GET /v4/projects/{project_id}/task-groups

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

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

约束限制:

不涉及。

取值范围:

32位项目ID。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及。

取值范围:

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

默认取值:

不涉及。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

group_total

Integer

参数解释:

任务分组总数。

取值范围:

大于等于0。

task_total

Integer

参数解释:

任务总数。

取值范围:

大于等于0。

result

Array of TaskGroupResult objects

参数解释:

任务分组的响应结果,以树形结构返回。

取值范围:

不涉及。

表4 TaskGroupResult

参数

参数类型

描述

id

String

参数解释:

任务分组节点的id。

取值范围:

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

name

String

参数解释:

任务分组节点名称。

取值范围:

不涉及。

task_total

Integer

参数解释:

任务分组节点下的任务总数。

取值范围:

大于等于0。

sons

TaskGroupResult object

参数解释:

任务分组节点的相关信息

取值范围:

不涉及

状态码:400

表5 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码

error_msg

String

错误描述

请求示例

获取project_id对应项目下的任务分组信息

GET https://{endpoint}/v4/projects/40a381e7abf9xxxxxx5d686561ad8a76/task-groups

响应示例

状态码:200

Request succeeded!

{
  "group_total" : 16,
  "task_total" : 17,
  "result" : [ {
    "id" : "fxxxx7ba3ae14a87a32b151bcbe20801",
    "name" : "task group name1",
    "sons" : [ {
      "id" : "fxxxx7ba3ae14a87a32b151bcbe20802",
      "name" : "task group name2"
    } ],
    "task_total" : 5
  }, {
    "id" : "fxxxx7ba3ae14a87a32b151bcbe20803",
    "name" : "task group name3",
    "task_total" : 12
  }, {
    "id" : "fxxxx7ba3ae14a87a32b151bcbe20804",
    "name" : "task group name4"
  } ]
}

状态码: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

错误码

请参见错误码

相关文档