查詢單個代碼庫詳情。
適用版本 | 企業標準版 |
服務接入點與授權信息
獲取服務接入點,替換 API 請求語法中的 <domain> :服務接入點(domain)。
獲取個人訪問令牌,具體操作,請參見獲取個人訪問令牌。
產品
資源
所需權限
代碼管理
代碼倉庫
只讀
請求語法
GET https://{domain}/oapi/v1/codeup/organizations/{organizationId}/repositories/{repositoryId}
請求頭
參數 | 類型 | 是否必填 | 描述 | 示例值 |
x-yunxiao-token | string | 是 | 個人訪問令牌。 | pt-0fh3****0fbG_35af****0484 |
請求參數
參數 | 類型 | 位置 | 是否必填 | 描述 | 示例值 |
organizationId | string | path | 是 | 組織 ID。 | 99d1****71d4 |
repositoryId | string | path | 是 | 代碼庫 ID 或者 URL-Encoder 編碼的全路徑。 | 2835387 或 codeup-org-id%2Fcodeup-demo |
請求示例
curl -X 'GET' \
'https://test.rdc.aliyuncs.com/oapi/v1/codeup/organizations/{organizationId}/repositories/{repositoryId}' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'
返回參數
參數 | 類型 | 描述 | 示例值 |
- | object | ||
accessLevel | integer | 當前用戶在該代碼庫上的權限類型。20-瀏覽者,30-開發者,40-管理員。 | 20 |
adminSettingLanguage | string | 倉庫主要編程語言。 | Java |
allowPush | boolean | 是否允許推送。 | false |
archived | boolean | 是否歸檔。 | false |
avatarUrl | string | 代碼庫頭像地址。 | https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100 |
cloneDownloadControlGray | boolean | 克隆/下載控制組織維度灰度開關。 | false |
createdAt | string | 創建時間。 | 2020-06-19T04:02:00.744Z |
creatorId | integer | 創建者 user id。 | 19258 |
defaultBranch | string | 代碼庫默認分支。 | master |
demoProject | boolean | 是否是 demo 庫。 | false |
description | string | 代碼庫描述。 | repo desc |
enableCloneDownloadControl | boolean | 是否開啟代碼克隆下載管控。 | false |
forkCount | integer | fork 數量。 | 1 |
httpUrlToRepo | string | HTTP 地址。 | https://codeup.aliyun.com/xxx/test/test.git |
id | integer | 代碼庫 ID。 | 100 |
lastActivityAt | string | 最后活躍時間。 | 2020-06-19T04:02:00.744Z |
name | string | 代碼庫名稱。 | test |
nameWithNamespace | string | 代碼庫完整名稱(含完整組名稱)。 | test / test(斜杠兩側有空格) |
namespace | object | ||
avatar | string | 頭像地址。 | https://xxx.jpg |
createdAt | string | 創建時間。 | 2020-06-19T04:02:00.744Z |
description | string | 描述。 | repo desc |
id | integer | ID。 | 100 |
name | string | 名稱。 | xxx |
ownerId | integer | 歸屬者 ID。 | 100 |
path | string | 路徑。 | test |
updatedAt | string | 更新時間。 | 2020-06-19T04:02:00.744Z |
visibility | string | 可見性。private:私有, internal:內部公開; public: 公開。 | private |
openCloneDownloadControl | boolean | 是否開啟克隆下載控制。 | false |
owner | object | ||
avatarUrl | string | 用戶頭像地址。 | https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100 |
string | 用戶郵箱。 | username@example.com | |
id | integer | 無業務意義主鍵 ID。 | 100 |
name | string | 用戶名稱。 | xxx |
state | string | 用戶狀態,可為{active, blocked}。 | active |
userId | string | 云效用戶 ID。 | 100 |
username | string | 用戶登錄名。 | test |
webUrl | string | 頁面訪問地址。 | "" |
path | string | 代碼庫路徑。 | test-create-group |
pathWithNamespace | string | 代碼庫完整路徑(含完整組路徑)。 | codeup-test-org/test-create-group |
permissions | object | 權限簡介。 | |
groupAccess | object | ||
accessLevel | integer | 組權限,可選{20-瀏覽者,30-開發者,40-管理員}。 | 30 |
notificationLevel | integer | 保留信息。 | |
projectAccess | object | ||
accessLevel | integer | 庫權限,可選{20-瀏覽者,30-開發者,40-管理員}。 | 30 |
notificationLevel | integer | 保留信息。 | |
projectType | integer | 代碼庫類型:1-普通代碼庫,2-模板代碼庫。 | 1 |
sshUrlToRepo | string | 倉庫 ssh 克隆地址。 | git@codeup.xxx.com:xxx/test/test.git |
starCount | integer | 收藏數量。 | 5 |
updatedAt | string | 更新時間。 | 2022-01-14T21:08:26+08:00 |
visibility | string | 可見性,包括{private-私有, internal-內部公開,public-公開。 | private |
webUrl | string | 頁面訪問時的 URL。 | "" |
返回示例
{
"accessLevel": 0,
"adminSettingLanguage": "Java",
"allowPush": false,
"archived": false,
"avatarUrl": "https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100",
"cloneDownloadControlGray": false,
"createdAt": "2020-06-19T04:02:00.744Z",
"creatorId": 0,
"defaultBranch": "master",
"demoProject": false,
"description": "描述信息的具體內容",
"enableCloneDownloadControl": false,
"forkCount": 1,
"httpUrlToRepo": "https://codeup.aliyun.com/xxx/test/test.git",
"id": 100,
"lastActivityAt": "2022-01-14T21:08:26+08:00",
"name": "test",
"nameWithNamespace": "codeup-test-org / test-create-group (斜杠兩側有空格)",
"namespace": {
"avatar": "",
"createdAt": "2022-01-14T21:08:26+08:00",
"description": "描述信息的具體內容",
"id": 0,
"name": "test",
"ownerId": 0,
"path": "",
"updatedAt": "2022-01-14T21:08:26+08:00",
"visibility": "private"
},
"openCloneDownloadControl": false,
"owner": {
"avatarUrl": "https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100",
"email": "username@example.com",
"id": 100,
"name": "xxx",
"state": "active",
"userId": "100",
"username": "test",
"webUrl": "xxx"
},
"path": "test-create-group",
"pathWithNamespace": "codeup-test-org/test-create-group",
"permissions": {
"groupAccess": {
"accessLevel": 30,
"notificationLevel": 0
},
"projectAccess": {
"accessLevel": 30,
"notificationLevel": 0
}
},
"projectType": 1,
"sshUrlToRepo": "gi*@xxx.aliyun.com:xxx/test/test.git",
"starCount": 5,
"updatedAt": "2022-01-14T21:08:26+08:00",
"visibility": "private",
"webUrl": ""
}
錯誤碼
訪問錯誤碼中心查看 API 相關錯誤碼。