获取项目下所有仓库信息
功能介绍
获取仓库列表 模糊查询支持范围,如果未传入project_id,则支持按仓库名或项目名模糊查询,否则,只按仓库名模糊匹配。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/projects/{project_uuid}/repositories
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_uuid |
是 |
String |
参数解释: 项目ID,获取方式请参见获取项目ID。约束限制: 不涉及。 取值范围: 只能由数字和字母组成,且长度为32个字符。 默认取值: 不涉及。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
page_index |
否 |
Integer |
参数解释: 分页索引。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 1 |
page_size |
否 |
Integer |
参数解释: 每页条目数。 约束限制: 不涉及。 取值范围: 1-100 默认取值: 20 |
search |
否 |
String |
参数解释: 搜索关键字。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
是 |
String |
参数解释: 用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 约束限制: 不涉及。 取值范围: 长度为[1,100000]个字符。 默认取值: 不涉及。 |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
error |
Error object |
参数解释: 响应错误 取值范围: 不涉及 |
result |
RepoListInfo object |
参数解释: 响应结果 取值范围: 不涉及 |
status |
String |
参数解释: 响应状态 取值范围:
|
参数 |
参数类型 |
描述 |
---|---|---|
code |
String |
参数解释: 错误码 取值范围: 符合错误码格式字符串,长度[0,100]。 |
message |
String |
参数解释: 错误信息 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
repositorys |
Array of RepoInfo objects |
参数解释: 仓库列表 取值范围: 不涉及 |
total |
Integer |
参数解释: 仓库总数 取值范围: 不涉及 |
参数 |
参数类型 |
描述 |
---|---|---|
createAt |
String |
参数解释: 创建时间 取值范围: 不涉及 |
groupName |
String |
参数解释: 仓库组名(克隆地址中域名后面仓库名前的一段 示例:git@repo.example.com:Demo00228/testword.git 组名:Demo00228) 取值范围: 不涉及 |
httpUrl |
String |
参数解释: 仓库https url 取值范围: 不涉及 |
id |
String |
参数解释: 仓库uuid 取值范围: 32位字符串 |
name |
String |
参数解释: 仓库名 取值范围: 不涉及 |
projectId |
String |
参数解释: 项目ID 取值范围: 32位字符串 |
projectIsDelete |
String |
项目是否被删除 |
repoId |
String |
参数解释: 仓库ID 取值范围: 1-40 |
sshUrl |
String |
参数解释: 仓库ssh url |
visibilityLevel |
Integer |
参数解释: 是否可见:0私有仓库,20公有仓库 取值范围:
|
webUrl |
String |
参数解释: 仓库web url 取值范围: 不涉及 |
请求示例
GET https://{endpoint}/v1/projects/{project_uuid}/repositories
响应示例
状态码: 200
OK
{ "result" : { "total" : 1, "repositorys" : [ { "id" : "d0457f74cc5b43d989ded7248f71b4e5", "repoId" : "468480", "name" : "CreatRepository_2qD5i", "sshUrl" : "git@repo.example.com:Demo00228/CreatRepository_2qD5i.git", "httpUrl" : "https://repo.example.com/Demo00228/CreatRepository_2qD5i.git", "groupName" : "Demo00228", "webUrl" : "https://repo.example.com/repo/468480/home", "visibilityLevel" : 0, "createAt" : "2019-10-15 09:40:26", "projectId" : "4838955a48e2492bbe44b31bc4c272f6", "projectIsDelete" : "false" } ], "status" : "success" } }
状态码
状态码 |
描述 |
---|---|
200 |
OK |
错误码
请参见错误码。