项目别名 API

  • Tier: 专业版, 旗舰版
  • Offering: 私有化部署

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

列出所有项目别名#

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

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

示例响应:

json
1[ 2 { 3 "id": 1, 4 "project_id": 1, 5 "name": "gitlab-foss" 6 }, 7 { 8 "id": 2, 9 "project_id": 2, 10 "name": "gitlab" 11 } 12]

获取项目别名的详细信息#

获取项目别名的详细信息:

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

示例响应:

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

创建项目别名#

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

plaintext
POST /project_aliases
属性类型必需描述
namestring别名的名称。必须唯一。
project_idinteger or string项目的 ID 或路径。
shell
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"

shell
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"

示例响应:

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

删除项目别名#

删除项目别名。如果项目别名存在则响应 204,如果不存在则响应 404:

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