文档

ListRepositories - 查询代码库列表

更新时间:

查询代码库列表。

适用版本

企业专属版、企业标准版

服务接入点与授权信息

请求语法

GET https://{domain}/oapi/v1/codeup/organizations/{organizationId}/repositories

请求头

参数

类型

是否必填

描述

示例值

x-yunxiao-token

string

个人访问令牌。

pt-0fh3****0fbG_35af****0484

请求参数

参数

类型

位置

是否必填

描述

示例值

organizationId

string

path

组织 ID。

99d1****71d4

page

integer

query

页码,默认从1开始,一般不要超过150页。

1

perPage

integer

query

每页大小,默认20,取值范围【1,100】。

20

orderBy

string

query

排序字段,可选值包括 {created_at, name, path, last_activity_at},默认值为 created_at。

created_at

sort

string

query

排序方式,可选值包括{asc, desc},默认值为 desc。

desc

search

string

query

搜索关键字,用户模糊匹配代码库路径。

Demo

archived

boolean

query

是否归档。

false

请求示例

curl -X 'GET' \
  'https://test.rdc.aliyuncs.com/oapi/v1/codeup/organizations/{organizationId}/repositories?page=<page>&perPage=<perPage>&orderBy=<orderBy>&sort=<sort>&search=<search>&archived=<archived>' \
  -H 'accept: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

返回参数

参数

类型

描述

示例值

-

array

-

object

accessLevel

integer

当前用户在该代码库上的权限类型。20-浏览者,30-开发者,40-管理员。

archived

boolean

代码库是否归档。

false

avatarUrl

string

头像地址。

https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100

createdAt

string

创建时间。

2022-01-14T21:08:26+08:00

demoProject

boolean

是否是 demo 库。

false

description

string

代码库描述。

测试Codeup托管

encrypted

boolean

是否加密。

false

id

integer

代码库 ID。

1

lastActivityAt

string

最后活跃时间。

2022-01-14T21:08:26+08:00

name

string

代码库名称。

codeupTest

nameWithNamespace

string

代码库完整名称(含完整组名称)。

codeup-test-org / test-codeup(斜杠两侧有空格)

namespaceId

integer

上级路径的 ID。

745

path

string

代码库路径。

test-codeup

pathWithNamespace

string

代码库完整路径(含完整组路径)。

codeup-test-org/test-codeup

repositorySize

string

代码库大小(MB)。

10

starCount

integer

被收藏的数量。

0

starred

boolean

是否被当前用户收藏。

false

updatedAt

string

最近更新时间。

2022-01-14T21:08:26+08:00

visibility

string

可见性,private 标识私有的,internal 标识组织内公开,public 表示全平台公开。

private

webUrl

string

页面访问时的 URL。

""

返回示例

[
    {
        "accessLevel": 0,
        "archived": false,
        "avatarUrl": "https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100",
        "createdAt": "2022-01-14T21:08:26+08:00",
        "demoProject": false,
        "description": "测试Codeup托管",
        "encrypted": false,
        "id": 0,
        "lastActivityAt": "2022-01-14T21:08:26+08:00",
        "name": "codeupTest",
        "nameWithNamespace": "codeup-test-org / test-codeup(斜杠两侧有空格)",
        "namespaceId": 745,
        "path": "test-codeup",
        "pathWithNamespace": "codeup-test-org/test-codeup",
        "repositorySize": "10",
        "starCount": 0,
        "starred": false,
        "updatedAt": "2022-01-14T21:08:26+08:00",
        "visibility": "private",
        "webUrl": "\"\""
    }
]

响应头

参数

描述

示例值

x-next-page

下一页。

2

x-page

当前页。

1

x-per-page

每页大小。

20

x-prev-page

前一页。

0

x-request-id

请求 ID。

37294673-00CA-5B8B-914F-A8B35511E90A

x-total

总数。

10

x-total-pages

总分页数。

1

错误码

访问错误码中心查看 API 相关错误码。