通過 OpenAPI 查詢程式碼群組空間資訊,可根據 ID 或路徑擷取單個空間或者程式碼群組的資訊。
服務存取點與授權資訊
產品 | 資源 | 要求的權限 |
代碼管理 | 程式碼群組 | 唯讀 |
請求文法
GET https://{domain}/oapi/v1/codeup/organizations/namespaces/{namespaceId}要求標頭
參數 | 類型 | 是否必填 | 描述 | 樣本值 |
x-yunxiao-token | string | 是 | 個人存取權杖。 | pt-0fh3****0fbG_35af****0484 |
請求參數
參數 | 類型 | 位置 | 是否必填 | 描述 | 樣本值 |
namespaceId | string | path | 是 | 空間或者程式碼群組 ID,或者全路徑。 | 1 |
請求樣本
curl -X 'GET' \
'https://{domain}/oapi/v1/codeup/organizations/namespaces/1' \
-H 'Content-Type: application/json' \
-H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'返回參數
參數 | 類型 | 描述 | 樣本值 |
| - | object | ||
avatarUrl | string | 頭像地址。 | https://example/example/w/100/h/100 |
fullPath | string | 空間完整路徑。 | 60de7a6852743a5162b5f957/DemoGroup |
id | integer | ID。 | 1 |
kind | string | 預設取值為 group。 | group |
name | string | 名稱。 | DemoGroup |
nameWithNamespace | string | 完整名稱。 | 60de7a6852743a5162b5f957 / DemoGroup |
parentId | integer | 上級路徑的 ID。 | 2 |
path | string | 路徑。 | DemoGroup |
pathWithNamespace | string | 完整路徑。 | 60de7a6852743a5162b5f957/DemoGroup |
visibility | string | 可見度,包括{private-私人,internal-組織內公開,public-公開},可能的值:[private internal public]。 | private |
webUrl | string | 頁面訪問時的 URL。 | http://example.com/60de7a6852743a5162b5f957/DemoGroup |
返回樣本
{
"avatarUrl": "https://example/example/w/100/h/100",
"fullPath": "60de7a6852743a5162b5f957/DemoGroup",
"id": 1,
"kind": "group",
"name": "DemoGroup",
"nameWithNamespace": "60de7a6852743a5162b5f957 / DemoGroup",
"parentId": 2,
"path": "DemoGroup",
"pathWithNamespace": "60de7a6852743a5162b5f957/DemoGroup",
"visibility": "private",
"webUrl": "http://example.com/60de7a6852743a5162b5f957/DemoGroup"
}錯誤碼
訪問錯誤碼中心查看 API 相關錯誤碼。