Skip to content
GitLab

系统别名 API (PREMIUM SELF)

所有的方法都需要管理员权限。

列出所有的系统别名

获得所有的系统别名列表：

GET /project_aliases
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/project_aliases"

响应示例：

[
  {
    "id": 1,
    "project_id": 1,
    "name": "gitlab-foss"
  },
  {
    "id": 2,
    "project_id": 2,
    "name": "gitlab"
  }
]

获取系统别名的详细信息

获取某系统别名的详细信息：

GET /project_aliases/:name
参数 类型 是否必需 描述
name string 是 别名的名字 
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/project_aliases/gitlab"

响应样例:

{
  "id": 1,
  "project_id": 1,
  "name": "gitlab"
}

创建一个系统别名

为某项目添加一个别名。成功会返回 201 Created。失败则会按照错误的不同来返回错误码，例如：别名已经存在，返回 400 Bad Request：

POST /project_aliases
参数 类型 是否必需 描述
project_id integer/string 是 项目的路径或者 ID
name string 是 独一无二的别名名字 
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/project_aliases" --form "project_id=1" --form "name=gitlab"

或

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/project_aliases" --form "project_id=gitlab-org/gitlab" --form "name=gitlab"

响应示例：

{
  "id": 1,
  "project_id": 1,
  "name": "gitlab"
}

删除一个系统别名

删除一个系统别名，成功返回 204 No Content, 如果没有该别名，则返回404 Not Found：

DELETE /project_aliases/:name
参数 类型 是否必需 描述
name string 是 别名的名字 
curl --request DELETE --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/project_aliases/gitlab"