{{< details >}}
- Tier: 专业版, 旗舰版
- Offering: 私有化部署
{{< /details >}}
所有方法都需要管理员授权。
列出所有项目别名
获取所有项目别名的列表:
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"