导入 API

版本历史

• 当导入到个人命名空间时，将贡献重新分配给个人命名空间所有者，已在极狐GitLab 18.3 中引入，并带有一个功能标志 user_mapping_to_personal_namespace_owner，默认禁用。
• 当导入到个人命名空间时，将贡献重新分配给个人命名空间所有者，已在极狐GitLab 18.6 中 GA，功能标志 user_mapping_to_personal_namespace_owner 已移除。

使用此 API 从外部源导入仓库。

从 GitHub 导入仓库#

版本历史

• 在极狐GitLab 16.0 中引入了要求维护者角色而非开发者角色，并向后移植到极狐GitLab 15.11.1 和 15.10.5。
• optional_stages 中的 collaborators_import 键在极狐GitLab 16.0 中引入。
• 功能标志 github_import_extended_events 在极狐GitLab 16.8 中引入，默认禁用。此标志提高了导入性能，但禁用了 single_endpoint_issue_events_import 可选阶段。
• 功能标志 github_import_extended_events 在极狐GitLab 16.9 中于 JihuLab.com 和私有化部署实例上启用。
• 改进的导入性能在极狐GitLab 16.11 中 GA，功能标志 github_import_extended_events 已移除。

从 GitHub 导入仓库到极狐GitLab。

先决条件：

• GitHub 导入器的先决条件。
• target_namespace 中设置的命名空间必须存在。
• 命名空间可以是您的用户命名空间，或者您拥有维护者或所有者角色的现有群组。

plaintext
POST /import/github

shell
1curl --request POST \
2  --url "https://gitlab.example.com/api/v4/import/github" \
3  --header "content-type: application/json" \
4  --header "Authorization: Bearer <your_access_token>" \
5  --data '{
6    "personal_access_token": "aBc123abC12aBc123abC12abC123+_A/c123",
7    "repo_id": "12345",
8    "target_namespace": "group/subgroup",
9    "new_name": "NEW-NAME",
10    "github_hostname": "https://github.example.com",
11    "optional_stages": {
12      "single_endpoint_notes_import": true,
13      "attachments_import": true,
14      "collaborators_import": true
15    }
16}'

optional_stages 可用的键如下：

• attachments_import，用于 Markdown 附件导入。
• collaborators_import，用于导入非外部协作者的直接仓库协作者。
• single_endpoint_issue_events_import，用于议题和拉取请求事件导入。此可选阶段在极狐GitLab 16.9 中已移除。
• single_endpoint_notes_import，用于替代且更彻底的评论导入。

更多信息，请参见选择要导入的额外项。

示例响应：

json
1{
2    "id": 27,
3    "name": "my-repo",
4    "full_path": "/root/my-repo",
5    "full_name": "Administrator / my-repo",
6    "refs_url": "/root/my-repo/refs",
7    "import_source": "my-github/repo",
8    "import_status": "scheduled",
9    "human_import_status_name": "scheduled",
10    "provider_link": "/my-github/repo",
11    "relation_type": null,
12    "import_warning": null
13}

通过 API 使用群组访问令牌导入公共项目#

当您通过 API 使用群组访问令牌从 GitHub 导入项目到极狐GitLab 时：

• 极狐GitLab 项目继承原始项目的可见性设置。因此，如果原始项目是公共的，该项目也是公共可访问的。
• 如果 path 或 target_namespace 不存在，项目导入将失败。

取消 GitHub 项目导入#

取消正在进行的 GitHub 项目导入。

plaintext
POST /import/github/cancel

shell
1curl --request POST \
2  --url "https://gitlab.example.com/api/v4/import/github/cancel" \
3  --header "content-type: application/json" \
4  --header "PRIVATE-TOKEN: <your_access_token>" \
5  --data '{
6    "project_id": 12345
7}'

示例响应：

json
1{
2    "id": 160,
3    "name": "my-repo",
4    "full_path": "/root/my-repo",
5    "full_name": "Administrator / my-repo",
6    "import_source": "source/source-repo",
7    "import_status": "canceled",
8    "human_import_status_name": "canceled",
9    "provider_link": "/source/source-repo"
10}

返回以下状态码：

• 200 OK：项目导入正在被取消。
• 400 Bad Request：无法取消项目导入。
• 404 Not Found：与 project_id 关联的项目不存在。

将 GitHub Gist 导入到极狐GitLab 代码片段#

将个人 GitHub Gist 导入到极狐GitLab 代码片段中。您可以导入最多包含 10 个文件的 Gist。超过 10 个文件的 GitHub Gist 将被跳过。您应手动迁移这些 GitHub Gist。

如果有任何 Gist 无法导入，将发送一封电子邮件，列出未导入的 Gist。

plaintext
POST /import/github/gists

shell
1curl --request POST \
2  --url "https://gitlab.example.com/api/v4/import/github/gists" \
3  --header "content-type: application/json" \
4  --header "PRIVATE-TOKEN: <your_gitlab_access_token>" \
5  --data '{
6    "personal_access_token": "<your_github_personal_access_token>"
7}'

返回以下状态码：

• 202 Accepted：Gist 导入已开始。
• 401 Unauthorized：用户的 GitHub 个人访问令牌无效。
• 422 Unprocessable Entity：Gist 导入已在进行中。
• 429 Too Many Requests：用户已超出 GitHub 的速率限制。

从 Bitbucket Server 导入仓库#

从 Bitbucket Server 导入仓库到极狐GitLab。

Bitbucket 项目键仅用于在 Bitbucket 中查找仓库。 如果您想将仓库导入到极狐GitLab 群组，则必须指定 target_namespace。 如果不指定 target_namespace，项目将导入到您的个人用户命名空间。

先决条件：

• 更多信息，请参见 Bitbucket Server 导入器的先决条件。

plaintext
POST /import/bitbucket_server

shell
1curl --request POST \
2  --url "https://gitlab.example.com/api/v4/import/bitbucket_server" \
3  --header "content-type: application/json" \
4  --header "PRIVATE-TOKEN: <your_access_token>" \
5  --data '{
6    "bitbucket_server_url": "http://bitbucket.example.com",
7    "bitbucket_server_username": "root",
8    "personal_access_token": "Nzk4MDcxODY4MDAyOiP8y410zF3tGAyLnHRv/E0+3xYs",
9    "bitbucket_server_project": "NEW",
10    "bitbucket_server_repo": "my-repo",
11    "new_name": "NEW-NAME"
12}'

从 Bitbucket Cloud 导入仓库#

版本历史

• 在极狐GitLab 17.0 中引入。
• 在极狐GitLab 18.9 中添加了对 Bitbucket Cloud API 令牌的支持。
• 在极狐GitLab 19.0 中移除了对 Bitbucket Cloud 应用密码的支持。

从 Bitbucket Cloud 导入仓库到极狐GitLab。

先决条件：

• Bitbucket Cloud 导入器的先决条件。
• 具有所需范围的 Bitbucket Cloud API 令牌。

plaintext
POST /import/bitbucket

shell
1curl --request POST \
2  --url "https://gitlab.example.com/api/v4/import/bitbucket" \
3  --header "content-type: application/json" \
4  --header "PRIVATE-TOKEN: <your_access_token>" \
5  --data '{
6    "bitbucket_email": "email@example.com",
7    "bitbucket_api_token": "your_bitbucket_api_token",
8    "repo_path": "username/my_project",
9    "target_namespace": "my_group/my_subgroup",
10    "new_name": "new_project_name"
11}'

Bitbucket Cloud API 令牌范围#

如果您使用 Bitbucket Cloud API 令牌进行身份验证，令牌必须具有以下范围：

• read:repository:bitbucket
• read:pullrequest:bitbucket
• read:issue:bitbucket
• read:wiki:bitbucket