查詢代碼庫列表。
適用版本 | 企業標準版 |
服務接入點與授權信息
獲取服務接入點，替換 API 請求語法中的 <domain> ：服務接入點（domain）。
獲取個人訪問令牌，具體操作，請參見獲取個人訪問令牌。
產品
資源
所需權限
代碼管理
代碼倉庫
只讀
請求語法
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 'Content-Type: 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 相關錯誤碼。