創建代碼庫。
適用版本 | 企業標準版 |
服務接入點與授權信息
獲取服務接入點，替換 API 請求語法中的 <domain> ：服務接入點（domain）。
獲取個人訪問令牌，具體操作，請參見獲取個人訪問令牌。
產品
資源
所需權限
代碼管理
代碼倉庫
讀寫
請求語法
POST https://{domain}/oapi/v1/codeup/organizations/{organizationId}/repositories請求頭
參數 | 類型 | 是否必填 | 描述 | 示例值 |
x-yunxiao-token | string | 是 | 個人訪問令牌。 | pt-0fh3****0fbG_35af****0484 |
請求參數
參數 | 類型 | 位置 | 是否必填 | 描述 | 示例值 |
organizationId | string | path | 是 | 組織 ID。 | 99d1****71d4 |
- | object | body | 否 | ||
avatarUrl | string | body | 否 | 代碼庫頭像地址。 | https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100 |
description | string | body | 否 | 代碼庫描述內容，最長不超過65535個字符。 | codeup repo description |
name | string | body | 否 | 代碼庫名稱。 | Demo庫 |
namespaceId | integer | body | 否 | 代碼庫父路徑 ID，若為空，則創建在組織路徑下。 | 2022（需要保證當前用戶在父路徑下有創建代碼庫的權限；若需要創建父路徑，那么namespaceId需要設置為組織的空間ID） |
path | string | body | 否 | 代碼庫路徑。 | Demo庫（與name保持同層級，name與path的值可以不同，若帶上了父路徑，那么需要設置createParentPath字段為true，且父路徑前面不加斜杠，如 parentPath/demo） |
readMeType | string | body | 否 | 自動創建 readme 類型: EMPTY - 空，USER_GUIDE - 引導 readme 文件。 | USER_GUIDE |
templateProject | object | body | 否 | ||
syncAllBranches | boolean | body | 否 | 是否導入模板庫所有分支。 | false |
templateProjectId | integer | body | 否 | 模板庫 ID。 | 1 |
templateType | integer | body | 否 | 模板類型，1-自定義模板，2-系統預置模板。 | 1 |
visibility | string | body | 否 | 代碼庫的可見性: private - 私有，internal - 組織內公開，public：公開。 | private |
請求示例
curl -X 'POST' \
'https://test.rdc.aliyuncs.com/oapi/v1/codeup/organizations/{organizationId}/repositories' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
--data '
{
"avatarUrl": "https://tcs-devops.aliyuncs.com/thumbnail/112afcb7a6a35c3f67f1bea827c4/w/100/h/100",
"description": "codeup repo description",
"name": "Demo庫",
"namespaceId": 0,
"path": "",
"readMeType": "",
"templateProject": {
"syncAllBranches": false,
"templateProjectId": 1,
"templateType": 1
},
"visibility": "private"
}'返回參數
參數 | 類型 | 描述 | 示例值 |
- | object | ||
accessLevel | integer | 當前用戶在該代碼庫上的權限類型。 | |
archived | boolean | 代碼庫是否歸檔。 | false |
avatarUrl | string | 頭像地址。 | "" |
createdAt | string | 創建時間。 | 2022-01-14T21:08:26+08:00 |
creatorId | integer | 代碼庫創建者。 | 1233 |
demoProject | boolean | 是否是 demo 庫。 | false |
description | string | 代碼庫描述。 | 線下測試 |
encrypted | boolean | 是否加密。 | false |
id | integer | 代碼庫 ID。 | 2959 |
lastActivityAt | string | 最后活躍時間。 | 2022-01-14T21:08:26+08:00 |
name | string | 代碼庫名稱。 | codeupTest |
nameWithNamespace | string | 代碼庫完整名稱（含完整組名稱）。 | codeup-test-org / test-codeup |
namespaceId | integer | 上級路徑的 ID。 | |
path | string | 代碼庫路徑。 | test-codeup |
pathWithNamespace | string | 代碼庫完整路徑（含完整組路徑）。 | codeup-test-org/test-codeup |
repositorySize | string | 代碼庫大小(MB)。 | 10 |
starCount | integer | 被收藏的數量。 | 5 |
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",
"creatorId": 0,
"demoProject": false,
"description": "描述信息的具體內容",
"encrypted": false,
"id": 0,
"lastActivityAt": "2022-01-14T21:08:26+08:00",
"name": "codeupTest",
"nameWithNamespace": "codeup-test-org / test-create-group （斜杠兩側有空格）",
"namespaceId": 0,
"path": "test-codeup",
"pathWithNamespace": "codeup-test-org/test-codeup",
"repositorySize": "10",
"starCount": 5,
"starred": false,
"updatedAt": "2022-01-14T21:08:26+08:00",
"visibility": "private",
"webUrl": "\"\""
}錯誤碼
訪問錯誤碼中心查看 API 相關錯誤碼。