• 전제 조건
• 내보내기 일정 설정
• 내보내기 상태
• Export download
• 파일 가져오기
• 원격 객체 저장소에서 파일 가져오기
• 단일 관계 가져오기
• 관계 가져오기 상태 확인
• AWS S3에서 파일 가져오기
• Import 상태
• 관련 주제

프로젝트 가져오기 및 내보내기 API

파일 전송을 사용하여 프로젝트 가져오기 및 내보내기 API를 사용하여 프로젝트를 가져오고 내보냅니다.

프로젝트 가져오기 및 내보내기 API를 사용하기 전에, 아마도 group import and export API 를 사용하고 싶을 것입니다.

프로젝트 가져오기 및 내보내기 API를 사용한 후에, 프로젝트 수준 CI/CD 변수 API 를 사용하고 싶을 것입니다.

Container Registry 를 여전히 Docker를 통한 일련의 풀 및 푸시로 마이그레이션해야 합니다. 빌드 아티팩트를 검색하려면 어떤 CI/CD 파이프라인이든 다시 실행하세요.

전제 조건

프로젝트 가져오기 및 내보내기 API의 전제조건은 다음을 참조하세요:

• 프로젝트 내보내기를 위한 전제 조건.
• 프로젝트 가져오기를 위한 전제 조건.

내보내기 일정 설정

새로운 내보내기를 시작하세요.

이 엔드포인트는 upload 해시 매개변수도 허용합니다. 이는 내보낸 프로젝트를 웹 서버나 S3 호환 플랫폼으로 업로드하는 데 필요한 모든 정보를 포함합니다. 내보내기에 대해 GitLab은:

• 최종 서버로의 바이너리 데이터 파일 업로드만 지원합니다.
• upload 요청과 함께 Content-Type: application/gzip 헤더를 전송합니다. 사전 서명된 URL에 이를 서명의 일부로 포함하도록 확인하세요.
• 프로젝트 내보내기 프로세스를 완료하는 데 시간이 걸릴 수 있습니다. 업로드 URL이 짧은 만료 시간을 갖지 않도록하고 내보내기 프로세스 전체 기간 동안 사용할 수 있도록하세요.
• 관리자는 최대 내보내기 파일 크기를 수정할 수 있습니다. 기본적으로 최대 크기는 무제한(0)입니다. 이를 변경하려면 다음 중 하나를 사용하여 max_export_size를 편집하세요.
  • GitLab UI.
  • Application settings API
• GitLab.com에는 최대 가져오기 파일 크기에 대한 고정된 한도가 있습니다. 자세한 내용은 계정 및 제한 설정을 참조하세요.

upload[url] 매개변수는 upload 매개변수가 있는 경우 필요합니다.

Amazon S3로 업로드하는 경우 객체 업로드를 위한 사전 서명된 URL 생성 문서 스크립트를 참조하여 upload[url]을 생성하세요. 알려진 문제로 인해(https://gitlab.com/gitlab-org/gitlab/-/issues/430277), Amazon S3에는 최대 5GB 파일 크기의 파일만 업로드할 수 있습니다.

POST /projects/:id/export

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
    "https://gitlab.example.com/api/v4/projects/1/export" \
    --data "upload[http_method]=PUT" \
    --data-urlencode "upload[url]=https://example-bucket.s3.eu-west-3.amazonaws.com/backup?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=<your_access_token>%2F20180312%2Feu-west-3%2Fs3%2Faws4_request&X-Amz-Date=20180312T110328Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=8413facb20ff33a49a147a0b4abcff4c8487cc33ee1f7e450c46e8f695569dbd"

{
  "message": "202 Accepted"
}

내보내기 상태

내보내기 상태를 가져옵니다.

GET /projects/:id/export

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  "https://gitlab.example.com/api/v4/projects/1/export"

상태는 다음 중 하나일 수 있습니다:

• none: 내보내기가 대기 중이고 시작되거나 완료되거나 재생성되거나 아무것도 없습니다.
• queued: 내보내기 요청이 받아들여지고 처리를 위해 대기열에 있습니다.
• started: 내보내기 프로세스가 시작되었으며 진행 중입니다. 프로젝트 내보내기 및 내보낸 파일에 대한 작업을 포함합니다.
• finished: 내보내기 프로세스가 완료되었고 사용자에게 알림이 전송되었습니다.
• regeneration_in_progress: 내보내기 파일이 다운로드할 수 있으며 새로운 내보내기를 생성하는 요청이 진행 중입니다.

내보내기가 완료된 경우에만 _links가 존재합니다.

created_at은 프로젝트 생성 타임스탬프이며 내보내기 시작 시간이 아닙니다.

{
  "id": 1,
  "description": "Itaque perspiciatis minima aspernatur corporis consequatur.",
  "name": "Gitlab Test",
  "name_with_namespace": "Gitlab Org / Gitlab Test",
  "path": "gitlab-test",
  "path_with_namespace": "gitlab-org/gitlab-test",
  "created_at": "2017-08-29T04:36:44.383Z",
  "export_status": "finished",
  "_links": {
    "api_url": "https://gitlab.example.com/api/v4/projects/1/export/download",
    "web_url": "https://gitlab.example.com/gitlab-org/gitlab-test/download_export"
  }
}

Export download

완료된 내보내기를 다운로드하세요.

GET /projects/:id/export/download

curl --header "PRIVATE-TOKEN: <your_access_token>" --remote-header-name \
     --remote-name "https://gitlab.example.com/api/v4/projects/5/export/download"

ls *export.tar.gz
2017-12-05_22-11-148_namespace_project_export.tar.gz

파일 가져오기

• GitLab 16.0에서 이슈된 개발자 역할 대신 메인테이너 역할이 필요합니다. GitLab 15.11.1 및 GitLab 15.10.5로 다운그레이드됩니다.

POST /projects/import

전달된 덮어쓰기 매개변수는 내보낸 파일 내에 정의된 모든 값을 우선합니다.

파일 시스템에서 파일을 업로드하려면 --form 인수를 사용하세요. 이로 인해 cURL이 Content-Type: multipart/form-data 헤더를 사용하여 데이터를 게시합니다. file= 매개변수는 파일 시스템의 파일을 가리키고 @로 앞에 와야 합니다. 예:

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --form "path=api-project" \
     --form "file=@/path/to/file" "https://gitlab.example.com/api/v4/projects/import"

cURL은 원격 서버에서 파일을 게시하는 것을 지원하지 않습니다. 이 예제는 Python의 open 메서드를 사용하여 프로젝트를 가져옵니다:

import requests

url =  'https://gitlab.example.com/api/v4/projects/import'
files = { "file": open("project_export.tar.gz", "rb") }
data = {
    "path": "example-project",
    "namespace": "example-group"
}
headers = {
    'Private-Token': "<your_access_token>"
}

requests.post(url, headers=headers, data=data, files=files)

{
  "id": 1,
  "description": null,
  "name": "api-project",
  "name_with_namespace": "Administrator / api-project",
  "path": "api-project",
  "path_with_namespace": "root/api-project",
  "created_at": "2018-02-13T09:05:58.023Z",
  "import_status": "scheduled",
  "correlation_id": "mezklWso3Za",
  "failed_relations": []
}

참고: 최대 가져오기 파일 크기는 관리자가 설정할 수 있습니다. 기본값은 0(무제한)입니다. 관리자는 최대 가져오기 파일 크기를 수정할 수 있습니다. Application settings API나 관리 영역에서 max_import_size 옵션을 사용하세요.

원격 객체 저장소에서 파일 가져오기

자세한 내용: 상태: 베타

플래그: 자체 관리형 GitLab에서는 기본적으로 이 기능을 사용할 수 있습니다. 기능을 숨기려면 관리자가 import_project_from_remote_file라는 기능 플래그를 비활성화할 수 있습니다. GitLab.com 및 GitLab Dedicated에서는 이 기능을 사용할 수 있습니다.

POST /projects/remote-import

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --header "Content-Type: application/json" \
  --url "https://gitlab.example.com/api/v4/projects/remote-import" \
  --data '{"url":"https://remoteobject/file?token=123123","path":"remote-project"}'

{
  "id": 1,
  "description": null,
  "name": "remote-project",
  "name_with_namespace": "Administrator / remote-project",
  "path": "remote-project",
  "path_with_namespace": "root/remote-project",
  "created_at": "2018-02-13T09:05:58.023Z",
  "import_status": "scheduled",
  "correlation_id": "mezklWso3Za",
  "failed_relations": [],
  "import_error": null
}

Content-Length 헤더는 유효한 숫자를 반환해야 합니다. 최대 파일 크기는 10 GB입니다. Content-Type 헤더는 application/gzip이어야 합니다.

단일 관계 가져오기

• GitLab 16.11에서 베타)로 도입되었으며 기본적으로 비활성화된 single_relation_import 플래그를 통해 활성화됩니다.
• 17.1에서 GitLab.com, Self-Managed 및 Dedicated에서 활성화됩니다.

이 엔드포인트는 프로젝트 내보내기 아카이브와 명명된 관계(이슈, 병합 요청, 파이프라인 또는 마일스톤)를 허용하고 해당 관계를 다시 가져와서 이미 가져온 항목은 건너뛰는 것을 허용합니다.

요구 사항 프로젝트 내보내기 파일은 파일 가져오기에 설명된 동일한 구조 및 크기 요구 사항을 준수해야합니다.

• 추출된 파일은 GitLab 프로젝트 내보내기의 구조를 준수해야합니다.
• 아카이브는 관리자가 구성한 최대 가져오기 파일 크기를 초과해서는 안 됩니다.

POST /projects/import-relation

파일 시스템에서 파일을 업로드하려면 cURL을 사용하여 데이터를 게시하는 --form 옵션을 사용합니다. file= 매개변수는 파일 시스템의 파일을 가리켜야하며 @로 선행해야합니다. 예:

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
     --form "path=api-project" \
     --form "file=@/path/to/file" \
     --form "relation=issues" \
     "https://gitlab.example.com/api/v4/projects/import-relation"

{
  "id": 9,
  "project_path": "namespace1/project1",
  "relation": "issues",
  "status": "finished"
}

관계 가져오기 상태 확인

• GitLab 16.11에서 도입되었습니다.

이 엔드포인트는 프로젝트와 관련된 모든 관계 가져오기의 상태를 가져옵니다. 하나의 관계 가져오기만 한 번에 예약될 수 있으므로, 이전 가져오기가 정상적으로 완료되었는지 확인하기 위해이 엔드포인트를 사용할 수 있습니다.

GET /projects/:id/relation-imports

curl --header "PRIVATE-TOKEN: <your_access_token>" \
     "https://gitlab.example.com/api/v4/projects/18/relation-imports"

[
  {
    "id": 1,
    "project_path": "namespace1/project1",
    "relation": "issues",
    "status": "created",
    "created_at": "2024-03-25T11:03:48.074Z",
    "updated_at": "2024-03-25T11:03:48.074Z"
  }
]

상태는 다음 중 하나가 될 수 있습니다:

• created : 가져오기가 예약되었지만 시작되지 않았습니다.
• started : 가져오기가 진행 중입니다.
• finished : 가져오기가 완료되었습니다.
• failed : 가져오기를 완료할 수 없었습니다.

AWS S3에서 파일 가져오기

• GitLab 15.11에서 일반적으로 사용 가능해졌습니다. import_project_from_remote_file_s3 기능 플래그가 제거되었습니다.

POST /projects/remote-import-s3

전달된 재정의 매개변수는 내보내기 파일에 정의된 모든 값보다 우선합니다.

curl --request POST \
  --url "https://gitlab.example.com/api/v4/projects/remote-import-s3" \
  --header "PRIVATE-TOKEN: <your gitlab access key>" \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Sample Project",
  "path": "sample-project",
  "region": "<Your S3 region name>",
  "bucket_name": "<Your S3 bucket name>",
  "file_key": "<Your S3 file key>",
  "access_key_id": "<Your AWS access key id>",
  "secret_access_key": "<Your AWS secret access key>"
}'

이 예는 Amazon S3 버킷에서 가져옵니다. Amazon S3에 연결하는 모듈을 사용합니다:

import requests
from io import BytesIO

s3_file = requests.get(presigned_url)

url =  'https://gitlab.example.com/api/v4/projects/import'
files = {'file': ('file.tar.gz', BytesIO(s3_file.content))}
data = {
    "path": "example-project",
    "namespace": "example-group"
}
headers = {
    'Private-Token': "<your_access_token>"
}

requests.post(url, headers=headers, data=data, files=files)

{
  "id": 1,
  "description": null,
  "name": "Sample project",
  "name_with_namespace": "Administrator / sample-project",
  "path": "sample-project",
  "path_with_namespace": "root/sample-project",
  "created_at": "2018-02-13T09:05:58.023Z",
  "import_status": "scheduled",
  "correlation_id": "mezklWso3Za",
  "failed_relations": [],
  "import_error": null
}

Import 상태

수입의 상태를 가져옵니다.

GET /projects/:id/import

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  "https://gitlab.example.com/api/v4/projects/1/import"

상태는 다음 중 하나일 수 있습니다:

• none
• scheduled
• failed
• started
• finished

상태가 failed인 경우 import_error 아래에 수입 오류 메시지가 포함됩니다. 상태가 failed, started, 또는 finished인 경우 failed_relations 배열에는 재시도가 고갈되거나 재시도 할 수 없는 오류로 수입이 실패한 관계의 발생 여부가 포함될 수 있습니다. 특히, 쿼리 시간 초과와 같은:

• 회복할 수 없는 오류.
• 재시도가 고갈되었습니다. 전형적인 예제: 쿼리 시간 초과.

참고: failed_relations의 요소 id 필드는 관계가 아닌 실패 레코드를 참조합니다.

참고: failed_relations 배열은 100개의 항목으로 제한됩니다.

{
  "id": 1,
  "description": "Itaque perspiciatis minima aspernatur corporis consequatur.",
  "name": "Gitlab 테스트",
  "name_with_namespace": "Gitlab Org / Gitlab Test",
  "path": "gitlab-test",
  "path_with_namespace": "gitlab-org/gitlab-test",
  "created_at": "2017-08-29T04:36:44.383Z",
  "import_status": "started",
  "import_type": "github",
  "correlation_id": "mezklWso3Za",
  "failed_relations": [
    {
      "id": 42,
      "created_at": "2020-04-02T14:48:59.526Z",
      "exception_class": "RuntimeError",
      "exception_message": "A failure occurred",
      "source": "custom error context",
      "relation_name": "merge_requests",
      "line_number": 0
    }
  ]
}

GitHub에서 가져올 때 stats 필드에서 이미 GitHub에서 얼마나 많은 개체가 가져오고 수입되었는지 나열됩니다:

{
  "id": 1,
  "description": "Itaque perspiciatis minima aspernatur corporis consequatur.",
  "name": "Gitlab Test",
  "name_with_namespace": "Gitlab Org / Gitlab Test",
  "path": "gitlab-test",
  "path_with_namespace": "gitlab-org/gitlab-test",
  "created_at": "2017-08-29T04:36:44.383Z",
  "import_status": "started",
  "import_type": "github",
  "correlation_id": "mezklWso3Za",
  "failed_relations": [
    {
      "id": 42,
      "created_at": "2020-04-02T14:48:59.526Z",
      "exception_class": "RuntimeError",
      "exception_message": "A failure occurred",
      "source": "custom error context",
      "relation_name": "merge_requests",
      "line_number": 0
    }
  ],
  "stats": {
    "fetched": {
      "diff_note": 19,
      "issue": 3,
      "label": 1,
      "note": 3,
      "pull_request": 2,
      "pull_request_merged_by": 1,
      "pull_request_review": 16
    },
    "imported": {
      "diff_note": 19,
      "issue": 3,
      "label": 1,
      "note": 3,
      "pull_request": 2,
      "pull_request_merged_by": 1,
      "pull_request_review": 16
    }
  }
}

관련 주제

• 파일 익스포트를 사용하여 프로젝트 이관.
• 프로젝트 이관 및 익스포트 Rake 작업.
• 그룹 이관 및 익스포트 API