可以获取迭代分组、需求分组、缺陷分组列表
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | ListCommonGroup |
系统规定参数。取值:ListCommonGroup。 |
OrgId | String | 是 | 60b89a1d749ddb003fxxxxx |
企业标识,也称企业id,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/【OrgId】 |
ProjectId | String | 是 | 60af1829a1dee1003fxxxxx |
项目ID,可以在项目链接中获取,如 https://devops.aliyun.com/project/【ProjectId】/story/section/all |
SmartGroupId | String | 是 | 60af1XXXX1dee1003fxxxxx |
类型分组id,参考ListSmartGroup API |
All | Boolean | 是 | true |
是否全部分组。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
ErrorMsg | String | "" |
错误信息 |
RequestId | String | ASSDS-ASSASX-XSAXSA-XSAXSAXS |
请求id,每次请求都是唯一值,便于后续排查问题 |
Successful | Boolean | true |
true 接口调用成功,false 接口调用失败 |
ErrorCode | String | "" |
错误码 |
Object | Array of CommonGroup |
分组 |
|
ResourceCount | Integer | 0 |
资源数 |
SmartGroupId | String | 5e9ee108424a50d98c7xxx |
smartGroupid |
Pos | Integer | 2 |
位置 |
ProjectId | String | 5e9ee108424a50d98c7xxx |
项目id |
IsRoot | Boolean | false |
是否根分组 |
Pinyin | String | default |
拼音 |
CreatorId | String | 5e9ee108424a50d98c7xxx |
创建者 |
Name | String | 未分类需求 |
分组名称 |
id | String | 5e9ee108424a50d98c7xxx |
分组id |
示例
请求示例
http(s)://[Endpoint]/?Action=ListCommonGroup
&OrgId=60b89a1d749ddb003fxxxxx
&SmartGroupId=60af1XXXX1dee1003fxxxxx
&ProjectId=60af1829a1dee1003fxxxxx
&<公共请求参数>
正常返回示例
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "ASSDS-ASSASX-XSAXSA-XSAXSAXS",
"ErrorMsg" : "\"\"",
"Object" : [ {
"IsRoot" : "false",
"SmartGroupId" : "5e9ee108424a50d98c7xxx",
"Pos" : "2",
"CreatorId" : "5e9ee108424a50d98c7xxx",
"Pinyin" : "default",
"ResourceCount" : "0",
"ProjectId" : "5e9ee108424a50d98c7xxx",
"id" : "5e9ee108424a50d98c7xxx",
"Name" : "未分类需求"
} ],
"ErrorCode" : "\"\"",
"Successful" : "true"
}
错误码
HttpCode | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidUser.UserNotInCurrentOrganization | The user does not belong to the specified organization. | 当前用户不属于该企业 |
404 | InvalidOrganization.NotFound | The specified organization doe not exist. | 企业信息有误,未找到该企业 |
404 | InvalidUser.NotFound | The specified user does not exist. | 用户数据有误,未找到该用户 |
访问错误中心查看更多错误码。