根据代码组全路径查询代码组信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
GET /api/4/groups/find_by_path HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| organizationId |
string |
是 |
企业标识,也称企业 id,字符串形式,可在云效访问链接中获取,如 https://devops.aliyun.com/organization/【OrganizationId】 |
60de7a6852743a5162b5f957 |
| identity |
string |
是 |
代码组全路径或者代码组 ID |
60de7a6852743a5162b5f957/test-group |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| requestId |
string |
请求 ID |
6177543A-8D54-5736-A93B-E0195A1512CB |
| success |
boolean |
调用是否成功 |
true |
| errorCode |
string |
错误码 |
SYSTEM_UNKNOWN_ERROR |
| errorMessage |
string |
错误信息 |
"" |
| result |
object |
返回代码组信息 |
|
| id |
integer |
代码组 ID,也是代码组的空间 ID |
30815 |
| name |
string |
代码组名称 |
test-group |
| path |
string |
代码组路径 |
test-group |
| pathWithNamespace |
string |
代码组路径(含完整父路径) |
codeup-test-org/test-group |
| nameWithNamespace |
string |
代码组名称(含完整父路径) |
codeup-test-org / test-group(斜杠两侧有空格) |
| visibilityLevel |
integer |
代码组的可见性
|
0 |
| description |
string |
代码组的描述信息 |
描述内容 |
| avatarUrl |
string |
代码组头像地址 |
https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100 |
| webUrl |
string |
页面访问时的 URL |
xxx |
| parentId |
string |
父路径 ID |
26842 |
| ownerId |
string |
拥有者 ID |
19230 |
示例
正常返回示例
JSON格式
{
"requestId": "6177543A-8D54-5736-A93B-E0195A1512CB",
"success": true,
"errorCode": "SYSTEM_UNKNOWN_ERROR",
"errorMessage": "\"\"",
"result": {
"id": 30815,
"name": "test-group",
"path": "test-group",
"pathWithNamespace": "codeup-test-org/test-group",
"nameWithNamespace": "codeup-test-org / test-group(斜杠两侧有空格)",
"visibilityLevel": 0,
"description": "描述内容",
"avatarUrl": "https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100",
"webUrl": "xxx",
"parentId": "26842",
"ownerId": "19230"
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。