스니펫 리포지터리 이동 API

Tier: Free, Premium, Ultimate Offering: Self-managed, GitLab Dedicated

스니펫 리포지터리는 리포지터리 간에 이동될 수 있습니다. 예를 들어, Gitaly 클러스터로 이관할 때 이 API를 사용할 수 있습니다.

스니펫 리포지터리 이동이 처리되면 다양한 상태를 거칩니다. state의 값은 다음과 같습니다.

  • initial: 레코드가 생성되었지만 백그라운드 작업이 아직 예정되지 않았습니다.
  • scheduled: 백그라운드 작업이 예정되었습니다.
  • started: 스니펫 리포지터리가 대상 리포지터리로 복사되고 있습니다.
  • replicated: 스니펫이 이동되었습니다.
  • failed: 스니펫 리포지터리의 복사에 실패하였거나 체크섬이 일치하지 않았습니다.
  • finished: 스니펫이 이동되고 소스 리포지터리의 리포지터리가 삭제되었습니다.
  • cleanup failed: 스니펫은 이동되었지만 소스 리포지터리의 리포지터리를 삭제할 수 없었습니다.

데이터 무결성을 보장하기 위해 스니펫은 이동 기간 동안 임시 읽기 전용 상태로 설정됩니다. 이 기간 동안 사용자는 새 커밋을 푸시하려고 하면 리포지터리가 임시로 읽기 전용입니다. 나중에 다시 시도해주세요.라는 메시지를 받게 됩니다.

이 API를 사용하려면 관리자로 인증해야 합니다.

다른 리포지터리 유형을 보려면:

모든 스니펫 리포지터리 이동 검색 

GET /snippet_repository_storage_moves

기본적으로 GET 요청은 API 결과가 페이징되기 때문에 한 번에 20개의 결과를 반환합니다.

예시 요청: 

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/snippet_repository_storage_moves"

예시 응답: 

[
  {
    "id": 1,
    "created_at": "2020-05-07T04:27:17.234Z",
    "state": "scheduled",
    "source_storage_name": "default",
    "destination_storage_name": "storage2",
    "snippet": {
      "id": 65,
      "title": "테스트 스니펫",
      "description": null,
      "visibility": "internal",
      "updated_at": "2020-12-01T11:15:50.385Z",
      "created_at": "2020-12-01T11:15:50.385Z",
      "project_id": null,
      "web_url": "https://gitlab.example.com/-/snippets/65",
      "raw_url": "https://gitlab.example.com/-/snippets/65/raw",
      "ssh_url_to_repo": "ssh://user@gitlab.example.com/snippets/65.git",
      "http_url_to_repo": "https://gitlab.example.com/snippets/65.git"
    }
  }
]

스니펫에 대한 모든 리포지터리 이동 검색 

GET /snippets/:snippet_id/repository_storage_moves

기본적으로 GET 요청은 API 결과가 페이징되기 때문에 한 번에 20개의 결과를 반환합니다.

지원되는 속성:

속성 타입 필수 여부 설명
snippet_id integer yes 스니펫의 ID.

예시 요청: 

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/snippets/1/repository_storage_moves"

예시 응답: 

[
  {
    "id": 1,
    "created_at": "2020-05-07T04:27:17.234Z",
    "state": "scheduled",
    "source_storage_name": "default",
    "destination_storage_name": "storage2",
    "snippet": {
      "id": 65,
      "title": "테스트 스니펫",
      "description": null,
      "visibility": "internal",
      "updated_at": "2020-12-01T11:15:50.385Z",
      "created_at": "2020-12-01T11:15:50.385Z",
      "project_id": null,
      "web_url": "https://gitlab.example.com/-/snippets/65",
      "raw_url": "https://gitlab.example.com/-/snippets/65/raw",
      "ssh_url_to_repo": "ssh://user@gitlab.example.com/snippets/65.git",
      "http_url_to_repo": "https://gitlab.example.com/snippets/65.git"
    }
  }
]

단일 스니펫 리포지터리 이동 검색 

GET /snippet_repository_storage_moves/:repository_storage_id

지원되는 속성:

속성 타입 필수 여부 설명
repository_storage_id integer yes 스니펫 리포지터리 이동의 ID.

예시 요청: 

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

예시 응답: 

{
  "id": 1,
  "created_at": "2020-05-07T04:27:17.234Z",
  "state": "scheduled",
  "source_storage_name": "default",
  "destination_storage_name": "storage2",
  "snippet": {
    "id": 65,
    "title": "테스트 스니펫",
    "description": null,
    "visibility": "internal",
    "updated_at": "2020-12-01T11:15:50.385Z",
    "created_at": "2020-12-01T11:15:50.385Z",
    "project_id": null,
    "web_url": "https://gitlab.example.com/-/snippets/65",
    "raw_url": "https://gitlab.example.com/-/snippets/65/raw",
    "ssh_url_to_repo": "ssh://user@gitlab.example.com/snippets/65.git",
    "http_url_to_repo": "https://gitlab.example.com/snippets/65.git"
  }
}

단일 리포지터리 스토리지 이동 얻기 스니펫 

GET /snippets/:snippet_id/repository_storage_moves/:repository_storage_id

지원되는 속성:

속성 유형 필수 설명
snippet_id 정수 예 스니펫의 ID입니다.
repository_storage_id 정수 예 스니펫 리포지터리 스토리지 이동의 ID입니다.

예제 요청: 

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/snippets/1/repository_storage_moves/1"

예제 응답: 

{
  "id": 1,
  "created_at": "2020-05-07T04:27:17.234Z",
  "state": "scheduled",
  "source_storage_name": "default",
  "destination_storage_name": "storage2",
  "snippet": {
    "id": 65,
    "title": "Test Snippet",
    "description": null,
    "visibility": "internal",
    "updated_at": "2020-12-01T11:15:50.385Z",
    "created_at": "2020-12-01T11:15:50.385Z",
    "project_id": null,
    "web_url": "https://gitlab.example.com/-/snippets/65",
    "raw_url": "https://gitlab.example.com/-/snippets/65/raw",
    "ssh_url_to_repo": "ssh://user@gitlab.example.com/snippets/65.git",
    "http_url_to_repo": "https://gitlab.example.com/snippets/65.git"
  }
}

스니펫을 위한 리포지터리 스토리지 이동 일정 설정 

POST /snippets/:snippet_id/repository_storage_moves

지원되는 속성:

속성 유형 필수 설명
snippet_id 정수 예 스니펫의 ID입니다.
destination_storage_name 문자열 아니요 목적지 리포지터리 샤드의 이름입니다. GitLab 13.5 이상에서는 제공되지 않으면 리포지터리 가중치에 따라 자동으로 선택됩니다.

예제 요청: 

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-Type: application/json" \
     --data '{"destination_storage_name":"storage2"}' \
     "https://gitlab.example.com/api/v4/snippets/1/repository_storage_moves"

예제 응답: 

{
  "id": 1,
  "created_at": "2020-05-07T04:27:17.234Z",
  "state": "scheduled",
  "source_storage_name": "default",
  "destination_storage_name": "storage2",
  "snippet": {
    "id": 65,
    "title": "Test Snippet",
    "description": null,
    "visibility": "internal",
    "updated_at": "2020-12-01T11:15:50.385Z",
    "created_at": "2020-12-01T11:15:50.385Z",
    "project_id": null,
    "web_url": "https://gitlab.example.com/-/snippets/65",
    "raw_url": "https://gitlab.example.com/-/snippets/65/raw",
    "ssh_url_to_repo": "ssh://user@gitlab.example.com/snippets/65.git",
    "http_url_to_repo": "https://gitlab.example.com/snippets/65.git"
  }
}

리포지터리 스토리지 이동 일정 설정 리포지터리 이동 스니펫 모두에 대한 켜냄

소스 리포지터리 샤드에 저장된 각 스니펫 리포지터리에 대해 리포지터리 스토리지 이동을 예약합니다. 이 엔드포인트는 한꺼번에 모든 스니펫을 이동합니다. 자세한 정보는 모든 스니펫을 이동하는을 참조하십시오. 

POST /snippet_repository_storage_moves

지원되는 속성:

속성 유형 필수 설명
source_storage_name 문자열 예 소스 리포지터리 샤드의 이름입니다.
destination_storage_name 문자열 아니요 대상 리포지터리 샤드의 이름입니다. 제공되지 않으면 리포지터리 가중치에 따라 자동으로 선택됩니다.

예제 요청: 

curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" \
     --header "Content-Type: application/json" \
     --data '{"source_storage_name":"default"}' \
     "https://gitlab.example.com/api/v4/snippet_repository_storage_moves"

예제 응답: 

{
  "message": "202 Accepted"
}