查询代码组空间信息-云效(Alibaba Cloud DevOps)-阿里云帮助中心

通过 OpenAPI 查询代码组空间信息，可根据 ID 或路径获取单个空间或者代码组的信息。

适用版本

中心版、Region版

服务接入点与授权信息

获取服务接入点：替换 API 请求语法中的 {domain} 。
获取个人访问令牌。
获取organizationId：仅中心版需要。请前往组织管理后台的基本信息页面获取组织 ID 。

产品	资源	所需权限
代码管理	代码组	只读

请求语法

中心版

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

Region版

GET https://{domain}/oapi/v1/codeup/namespaces/{namespaceId}

请求头

参数	类型	是否必填	描述	示例值
x-yunxiao-token	string	是	个人访问令牌。	pt-0fh3**0fbG_35af**0484

请求参数

参数	类型	位置	是否必填	描述	示例值
organizationId	string	path	是：中心版否：Region版	组织 ID。	60d54f3daccf2bbd6659f3ad
namespaceId	string	path	是	空间或者代码组 ID，或者全路径。	1

请求示例

中心版

curl -X 'GET' \
  'https://{domain}/oapi/v1/codeup/organizations/60d54f3daccf2bbd6659f3ad/namespaces/1' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484'

Region版

curl -X 'GET' \
  'https://{domain}/oapi/v1/codeup/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 相关错误码。