更新时间:2024-09-02 GMT+08:00
分享

查询用户的所有仓库

功能介绍

获取用户的所有仓库信息

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

URI

GET /v2/projects/repositories

表1 Query参数

参数

是否必选

参数类型

描述

page_index

Integer

参数解释:

分页索引。

取值范围:

最小值:1

最大值:2147483647

默认取值:

1

page_size

Integer

参数解释:

每页条目数。

取值范围:

最小值:1

最大值:100

默认取值:

100

search

String

参数解释:

搜索关键字。

取值范围:

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

默认取值:

空。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

必传。

取值范围:

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

默认取值:

不涉及。

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

error

Error object

参数解释:

接口调用时,响应错误。

取值范围:

无。

result

RepoListInfoV2 object

参数解释:

接口调用的响应结果。

取值范围:

无。

status

String

参数解释:

调用此接口的响应状态。

取值范围:

  • success,表示接口调用成功。
  • failed,表示接口调用失败。
表4 Error

参数

参数类型

描述

code

String

参数解释:

调用此接口失败时返回的错误码。

取值范围:

  • CH.080002

message

String

参数解释:

调用此接口失败时返回的错误码。

取值范围:

  • CH.080002 参数错误。
表5 RepoListInfoV2

参数

参数类型

描述

repositories

Array of RepoInfoV2 objects

参数解释:

返回的仓库列表。

total

Integer

参数解释:

返回的仓库总数。

取值范围:

0-2147483647

表6 RepoInfoV2

参数

参数类型

描述

created_at

String

参数解释:

创建时间。

约束限制:

格式: yyyy-MM-dd HH:mm:ss

creator_name

String

参数解释:

创建者的用户名。

取值范围:

只能为数字和字母,长度为128字符。

domain_name

String

参数解释:

创建者的租户名。

取值范围:

只能为数字和字母,长度为128字符。

group_name

String

参数解释:

仓库代码组名。 (克隆地址中域名后面仓库名前的一段。

示例:git@repo.alpha.devcloud.test.com:Demo00228/testword.git 代码组名:Demo00228 )

取值范围:

字符串长度不少于2,不超过255。

https_url

String

参数解释:

HTTPS仓库地址。

取值范围:

字符串长度不少于0,不超过2000。

iam_user_uuid

String

参数解释:

用户IAM ID。

取值范围:

只能由数字和字母组成,且长度为32个字符。

is_owner

Integer

参数解释:

是否是仓库的创建者。

取值范围:

1: 是创建者。

0: 不是创建者。

lfs_size

String

参数解释:

仓库 LFS 容量。

约束限制:

单位M,或者G,保留2位小数。

project_is_deleted

String

参数解释:

项目是否被删除。

取值范围:

false: 项目没有删除。

true: 项目已经删除。

project_uuid

String

参数解释:

项目ID,获取方式请参见获取项目ID

取值范围:

只能由数字和字母组成,且长度为32个字符。

repository_id

Integer

参数解释:

仓库ID。

取值范围:

只能由数字组成,且范围为0-2147483647。

repository_name

String

参数解释:

仓库名。

取值范围:

字符串长度不少于2,不超过255。

repository_size

String

参数解释:

仓库总容量 = 仓库LFS容量 + git库容量。

约束限制:

单位M,或者G,保留2为小数。

repository_uuid

String

参数解释:

仓库UUID(由CreateRepository接口返回)。

约束限制:

只能由数字和字母组成,且长度为32个字符。

ssh_url

String

参数解释:

SSH仓库地址。

取值范围:

字符串长度不少于0,不超过2000。

star

Boolean

参数解释:

当前用户是否收藏该仓库。

取值范围:

false: 未收藏。

true: 已收藏。

status

Integer

参数解释:

仓库状态。

取值范围:

0: 仓库正常创建成功。

1: 仓库创建中。

2: 创建失败。

3: 仓库冻结。

4: 仓库已经关闭。

updated_at

String

参数解释:

更新时间。

约束限制:

格式: yyyy-MM-dd HH:mm:ss。

userRole

Integer

参数解释:

用户在仓库中的角色。

约束限制:

20: 只读成员。

30: 普通成员 。

40: 管理员。

visibility_level

Integer

参数解释:

仓库可见性。

取值范围:

0: 私有仓库。

20: 公有仓库。

web_url

String

参数解释:

web url 路径,访问它将跳转至仓库详情页。

取值范围:

字符串长度不少于0,不超过2000。

请求示例

GET https://{endpoint}/v2/projects/repositories

响应示例

状态码: 200

OK

{
  "result" : {
    "total" : 29,
    "repositories" : {
      "repository_uuid" : "0bf1e7ceb5b341318cb72b42901abe54",
      "repository_id" : 468564,
      "repository_name" : "test",
      "ssh_url" : "git@repo.alpha.devcloud.test.com:test_new00001/test.git",
      "https_url" : "https://repo.alpha.devcloud.test.com/test_new00001/test.git",
      "group_name" : "test_new00001",
      "web_url" : "https://alpha.devcloud.test.com/repo/468564/home",
      "visibility_level" : 0,
      "created_at" : "2019-10-15 11:00:11",
      "updated_at" : "2019-10-15 11:00:11",
      "repository_size" : "0.05M",
      "lfs_size" : "0.00M",
      "creator_name" : "repo",
      "domain_name" : "repo",
      "star" : true,
      "status" : 0,
      "is_owner" : 1,
      "iam_user_uuid" : "a618e34bd5704be3ae3395dfede06041",
      "project_uuid" : "dc19b3ca6f334ce894a1ec467689797d",
      "project_is_deleted" : "false",
      "userRole" : null
    }
  },
  "status" : "success"
}

状态码

状态码

描述

200

OK

错误码

请参见错误码

相关文档