그룹 및 프로젝트 이전을 위한 직접 전송 API


Tier: Free, Premium, Ultimate
Offering: GitLab.com, 자체 관리, GitLab 전용

직접 전송 API를 사용하여 그룹 이전을 실행하고 진행 상황을 볼 수 있습니다.
group migration by direct transfer로 시작된 마이그레이션에 대한 정보입니다.

경고:
이 API를 사용하여 프로젝트를 이전하는 것은 베타 단계입니다. 이 기능은 생산 환경에서 사용할 준비가되지 않았습니다.

전제 조건

직접 전송 API에 의한 그룹 이전 전제 조건에 대한 정보는 직접 전송을 통한 그룹 이전 수를 참조하세요.

새 그룹 또는 프로젝트 이전 시작

새 그룹이나 프로젝트 이전을 시작하려면 이 엔드포인트를 사용하세요. 다음 사항을 지정합니다:

  • 그룹을 이전하려면 entities[group_entity]을 지정합니다.
  • 프로젝트를 이전하려면 entities[project_entity]을 지정합니다. (상태: 베타) 
POST /bulk_imports
속성 유형 필수 설명
configuration Hash yes 소스 GitLab 인스턴스 구성
configuration[url] String yes 소스 GitLab 인스턴스 URL
configuration[access_token] String yes 소스 GitLab 인스턴스 액세스 토큰
entities Array yes 가져올 엔터티 목록
entities[source_type] String yes 소스 엔터티 유형. 유효한 값은 group_entity 및 project_entity입니다 (GitLab 15.11 이후). 
curl --request POST --header "PRIVATE-TOKEN: <your_access_token_for_destination_gitlab_instance>" "https://destination-gitlab-instance.example.com/api/v4/bulk_imports" \
  --header "Content-Type: application/json" \
  --data '{
    "configuration": {
      "url": "https://source-gitlab-instance.example.com",
      "access_token": "<your_access_token_for_source_gitlab_instance>"
    },
    "entities": [
      {
        "source_full_path": "source/full/path",
        "source_type": "group_entity",
        "destination_slug": "destination_slug",
        "destination_namespace": "destination/namespace/path"
      }
    ]
  }'

{
  "id": 1,
  "status": "created",
  "source_type": "gitlab",
  "source_url": "https://gitlab.example.com",
  "created_at": "2021-06-18T09:45:55.358Z",
  "updated_at": "2021-06-18T09:46:27.003Z",
  "has_failures": false
}

모든 그룹 또는 프로젝트 이전 목록 

GET /bulk_imports
속성 유형 필수 설명
per_page integer no 페이지별 반환할 레코드 수
page integer no 검색할 페이지
sort string no 생성 날짜별 레코드를 asc 또는 desc 순서로 반환합니다. 기본값은 desc
status string no 가져오기 상태

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

  • created
  • started
  • finished
  • failed 
curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/bulk_imports?per_page=2&page=1"

[
    {
        "id": 1,
        "status": "finished",
        "source_type": "gitlab",
        "source_url": "https://gitlab.example.com",
        "created_at": "2021-06-18T09:45:55.358Z",
        "updated_at": "2021-06-18T09:46:27.003Z",
        "has_failures": false
    },
    {
        "id": 2,
        "status": "started",
        "source_type": "gitlab",
        "source_url": "https://gitlab.example.com",
        "created_at": "2021-06-18T09:47:36.581Z",
        "updated_at": "2021-06-18T09:47:58.286Z",
        "has_failures": false
    }
]

모든 그룹 또는 프로젝트 이전 엔터티 목록 

GET /bulk_imports/entities
속성 유형 필수 설명
per_page integer no 페이지별 반환할 레코드 수
page integer no 검색할 페이지
sort string no 생성 날짜별 레코드를 asc 또는 desc 순서로 반환합니다. 기본값은 desc
status string no 가져오기 상태

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

  • created
  • started
  • finished
  • failed 
curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/bulk_imports/entities?per_page=2&page=1&status=started"

[
    {
        "id": 1,
        "bulk_import_id": 1,
        "status": "finished",
        "entity_type": "group",
        "source_full_path": "source_group",
        "destination_full_path": "destination/full_path",
        "destination_name": "destination_slug",
        "destination_slug": "destination_slug",
        "destination_namespace": "destination_path",
        "parent_id": null,
        "namespace_id": 1,
        "project_id": null,
        "created_at": "2021-06-18T09:47:37.390Z",
        "updated_at": "2021-06-18T09:47:51.867Z",
        "failures": [],
        "migrate_projects": true,
        "has_failures": false,
        "stats": {
            "labels": {
                "source": 10,
                "fetched": 10,
                "imported": 10
            },
            "milestones": {
                "source": 10,
                "fetched": 10,
                "imported": 10
            }
        }
    },
    {
        "id": 2,
        "bulk_import_id": 2,
        "status": "failed",
        "entity_type": "group",
        "source_full_path": "another_group",
        "destination_full_path": "destination/full_path",
        "destination_name": "destination_slug",
        "destination_slug": "another_slug",
        "destination_namespace": "another_namespace",
        "parent_id": null,
        "namespace_id": null,
        "project_id": null,
        "created_at": "2021-06-24T10:40:20.110Z",
        "updated_at": "2021-06-24T10:40:46.590Z",
        "failures": [
            {
                "relation": "group",
                "step": "extractor",
                "exception_message": "Error!",
                "exception_class": "Exception",
                "correlation_id_value": "dfcf583058ed4508e4c7c617bd7f0edd",
                "created_at": "2021-06-24T10:40:46.495Z",
                "pipeline_class": "BulkImports::Groups::Pipelines::GroupPipeline",
                "pipeline_step": "extractor"
            }
        ],
        "migrate_projects": true,
        "has_failures": false,
        "stats": { }
    }
]

그룹 또는 프로젝트 이전 세부 정보 가져오기 

GET /bulk_imports/:id

curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/bulk_imports/1"

{
  "id": 1,
  "status": "finished",
  "source_type": "gitlab",
  "source_url": "https://gitlab.example.com",
  "created_at": "2021-06-18T09:45:55.358Z",
  "updated_at": "2021-06-18T09:46:27.003Z"
}

그룹 또는 프로젝트 이전 엔티티 목록 

GET /bulk_imports/:id/entities
속성 유형 필요 여부 설명
per_page integer no 페이지 당 반환할 레코드 수.
page integer no 검색할 페이지.
sort string no 작성일에 따라 asc 또는 desc 순서로 정렬된 레코드를 반환합니다. 기본값은 desc입니다.
status string no 가져오기 상태.

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

  • created
  • started
  • finished
  • failed 
curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/bulk_imports/1/entities?per_page=2&page=1&status=finished"

[
    {
        "id": 1,
        "bulk_import_id": 1,
        "status": "finished",
        "entity_type": "group",
        "source_full_path": "source_group",
        "destination_full_path": "destination/full_path",
        "destination_name": "destination_slug",
        "destination_slug": "destination_slug",
        "destination_namespace": "destination_path",
        "parent_id": null,
        "namespace_id": 1,
        "project_id": null,
        "created_at": "2021-06-18T09:47:37.390Z",
        "updated_at": "2021-06-18T09:47:51.867Z",
        "failures": [
            {
                "relation": "group",
                "step": "extractor",
                "exception_message": "Error!",
                "exception_class": "Exception",
                "correlation_id_value": "dfcf583058ed4508e4c7c617bd7f0edd",
                "created_at": "2021-06-24T10:40:46.495Z",
                "pipeline_class": "BulkImports::Groups::Pipelines::GroupPipeline",
                "pipeline_step": "extractor"
            }
        ],
        "migrate_projects": true,
        "has_failures": true,
        "stats": {
            "labels": {
                "source": 10,
                "fetched": 10,
                "imported": 10
            },
            "milestones": {
                "source": 10,
                "fetched": 10,
                "imported": 10
            }
        }
    }
]

그룹 또는 프로젝트 이전 엔티티 세부 정보 가져오기 

GET /bulk_imports/:id/entities/:entity_id

curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/bulk_imports/1/entities/2"

{
    "id": 1,
    "bulk_import_id": 1,
    "status": "finished",
    "entity_type": "group",
    "source_full_path": "source_group",
    "destination_full_path": "destination/full_path",
    "destination_name": "destination_slug",
    "destination_slug": "destination_slug",
    "destination_namespace": "destination_path",
    "parent_id": null,
    "namespace_id": 1,
    "project_id": null,
    "created_at": "2021-06-18T09:47:37.390Z",
    "updated_at": "2021-06-18T09:47:51.867Z",
    "failures": [
        {
            "relation": "group",
            "step": "extractor",
            "exception_message": "Error!",
            "exception_class": "Exception",
            "correlation_id_value": "dfcf583058ed4508e4c7c617bd7f0edd",
            "created_at": "2021-06-24T10:40:46.495Z",
            "pipeline_class": "BulkImports::Groups::Pipelines::GroupPipeline",
            "pipeline_step": "extractor"
        }
    ],
    "migrate_projects": true,
    "has_failures": true,
    "stats": {
        "labels": {
            "source": 10,
            "fetched": 10,
            "imported": 10
        },
        "milestones": {
            "source": 10,
            "fetched": 10,
            "imported": 10
        }
    }
}

그룹 또는 프로젝트 이전 엔티티에 대한 실패한 가져오기 레코드 목록 

GET /bulk_imports/:id/entities/:entity_id/failures

curl --request GET --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/bulk_imports/1/entities/2/failures"

{
  "relation": "issues",
  "exception_message": "Error!",
  "exception_class": "StandardError",
  "correlation_id_value": "06289e4b064329a69de7bb2d7a1b5a97",
  "source_url": "https://gitlab.example/project/full/path/-/issues/1",
  "source_title": "Issue title"
}

이전 취소하기

직접 이전을 취소합니다. 

POST /bulk_imports/:id/cancel

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/bulk_imports/1/cancel"

{
  "id": 1,
  "status": "canceled",
  "source_type": "gitlab",
  "created_at": "2021-06-18T09:45:55.358Z",
  "updated_at": "2021-06-18T09:46:27.003Z",
  "has_failures": false
}

가능한 응답 상태 코드:

상태 설명
200 이전이 성공적으로 취소됨
401 무단 액세스
403 금지됨
404 이전을 찾을 수 없음
503 서비스를 사용할 수 없음