列出项目下的分组信息 - ListPortalServiceTaskGroup
功能介绍
根据项目ID查询项目下的所有分组信息，返回分组ID、分组名和分组下的代码检查任务数。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备如下身份策略权限，更多的权限说明请参见权限和授权项。
授权项 | 访问级别 | 资源类型（*为必须） | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
codeartscheck:task:list | List | task * | - | - | - |
- | codeartscheck:ProjectId |
URI
GET /v4/projects/{project_id}/task-groups
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
project_id | 是 | String | 参数解释： 项目的32位UUID，项目唯一标识，通过查询项目列表接口获取。 约束限制： 不涉及。 取值范围： 长度为[1~32]个字符。 默认取值： 不涉及。 |
请求参数
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
X-Auth-Token | 是 | String | 参数解释： 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 约束限制： 不涉及。 取值范围： 长度为[1~100000]个字符。 默认取值： 不涉及。 |
响应参数
状态码：200
参数 | 参数类型 | 描述 |
|---|---|---|
group_total | Integer | 参数解释： 任务分组总数。 取值范围： ≥0 |
task_total | Integer | 参数解释： 任务总数。 取值范围： ≥0 |
result | Array of TaskGroupResult objects | 参数解释： 任务分组的响应结果，以树形结构返回。 取值范围： 不涉及。 |
参数 | 参数类型 | 描述 |
|---|---|---|
id | String | 参数解释： 任务分组节点的ID。 取值范围： 字符串长度不少于1，不超过128。 |
name | String | 参数解释： 任务分组节点名称。 取值范围： 不涉及。 |
task_total | Integer | 参数解释： 任务分组节点下的任务总数。 取值范围： ≥0 |
sons | TaskGroupResult object | 参数解释： 任务分组节点的相关信息。 取值范围： 不涉及。 |
状态码：400
参数 | 参数类型 | 描述 |
|---|---|---|
error_code | String | 参数解释： 错误码。 取值范围： 不涉及。 |
error_msg | String | 参数解释： 错误描述。 取值范围： 不涉及。 |
状态码：401
参数 | 参数类型 | 描述 |
|---|---|---|
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.xxxxxxxx.400",
"error_msg" : "请求参数校验失败,请检查请求参数是否正确"
} 状态码：401
Unauthorized
{
"error_code" : "CC.00000003",
"error_msg" : "认证信息过期"
} 状态码
状态码 | 描述 |
|---|---|
200 | Request succeeded! |
400 | Bad Request |
401 | Unauthorized |
错误码
请参见错误码。
