검색 관리자 API

Tier: Premium, Ultimate Offering: Self-managed

검색 관리자 API는 고급 검색 마이그레이션에 대한 정보를 반환합니다.

이 API를 사용하려면 관리자 액세스 권한이 필요합니다.

모든 고급 검색 마이그레이션 목록 가져오기

GitLab 인스턴스에 대한 모든 고급 검색 마이그레이션의 목록을 가져옵니다.

GET /admin/search/migrations

예제 요청:

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://primary.example.com/api/v4/admin/search/migrations"

예제 응답:

[
  {
    "version": 20230427555555,
    "name": "BackfillHiddenOnMergeRequests",
    "started_at": "2023-05-12T01:35:05.469+00:00",
    "completed_at": "2023-05-12T01:36:06.432+00:00",
    "completed": true,
    "obsolete": false,
    "migration_state": {}
  },
  {
    "version": 20230428500000,
    "name": "AddSuffixProjectInWikiRid",
    "started_at": "2023-05-04T18:59:43.542+00:00",
    "completed_at": "2023-05-04T18:59:43.542+00:00",
    "completed": false,
    "obsolete": false,
    "migration_state": {
      "pause_indexing": true,
      "slice": 1,
      "task_id": null,
      "max_slices": 5,
      "retry_attempt": 0
    }
  },
  {
    "version": 20230503064300,
    "name": "BackfillProjectPermissionsInBlobsUsingPermutations",
    "started_at": "2023-05-03T16:04:44.074+00:00",
    "completed_at": "2023-05-03T16:04:44.074+00:00",
    "completed": true,
    "obsolete": false,
    "migration_state": {
      "permutation_idx": 8,
      "documents_remaining": 5,
      "task_id": "I2_LXc-xQlOeu-KmjYpM8g:172820",
      "documents_remaining_for_permutation": 0
    }
  }
]

고급 검색 마이그레이션 가져오기

마이그레이션 버전 또는 이름을 제공하여 단일 고급 검색 마이그레이션을 가져옵니다.

GET /admin/search/mirations/:version_or_name

매개변수:

속성 유형 필수 설명
version_or_name 정수/문자열 예 마이그레이션의 버전 또는 이름입니다.

예제 요청:

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://primary.example.com/api/v4/admin/search/mirations/20230503064300"
curl --header "PRIVATE-TOKEN: <your_access_token>" "https://primary.example.com/api/v4/admin/search/mirations/BackfillProjectPermissionsInBlobsUsingPermutations"

성공하면 200를 반환하고 다음 응답 속성을 반환합니다:

속성 유형 설명
version 정수 마이그레이션의 버전입니다.
name 문자열 마이그레이션의 이름입니다.
started_at 날짜시간 마이그레이션의 시작 날짜입니다.
completed_at 날짜시간 마이그레이션의 완료 날짜입니다.
completed 불리언 true인 경우, 마이그레이션이 완료된 것입니다.
obsolete 불리언 true인 경우, 마이그레이션이 더 이상 사용되지 않습니다.
migration_state 객체 저장된 마이그레이션 상태입니다.

예제 응답:

{
  "version": 20230503064300,
  "name": "BackfillProjectPermissionsInBlobsUsingPermutations",
  "started_at": "2023-05-03T16:04:44.074+00:00",
  "completed_at": "2023-05-03T16:04:44.074+00:00",
  "completed": true,
  "obsolete": false,
  "migration_state": {
    "permutation_idx": 8,
    "documents_remaining": 5,
    "task_id": "I2_LXc-xQlOeu-KmjYpM8g:172820",
    "documents_remaining_for_permutation": 0
  }
}