Help us learn about your current experience with the documentation. Take the survey.

项目别名 API

  • Tier: Premium, Ultimate
  • Offering: GitLab Self-Managed, GitLab Dedicated

使用此 API 添加、更改或删除项目别名。为项目创建别名后，用户可以使用该别名克隆仓库，这在迁移仓库时很有帮助。

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

列出所有项目别名

获取所有项目别名的列表：

GET /project_aliases
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "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>" \
  --url "https://gitlab.example.com/api/v4/project_aliases/gitlab"

示例响应：

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

创建项目别名

为项目添加新别名。成功时响应 201 Created。 当存在验证错误时，例如别名已存在，响应 400 Bad Request：

POST /project_aliases
属性 类型 必需 描述
name string 是 别名的名称。必须唯一。
project_id integer or string 是 项目的 ID 或路径。 
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/project_aliases" \
  --form "project_id=1" \
  --form "name=gitlab"

或

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "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，不存在时响应 404：

DELETE /project_aliases/:name
属性 类型 必需 描述
name string 是 别名的名称。 
curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/project_aliases/gitlab"