검색 관리자 API
Tier: Premium, Ultimate
Offering: GitLab Self-Managed
Offering: GitLab Self-Managed
요약
이 API를 사용하여 고급 검색 마이그레이션에 대한 정보를 조회합니다. GitLab 인스턴스의 모든 고급 검색 마이그레이션을 나열합니다. 마이그레이션 버전 또는 이름으로 지정된 고급 검색 마이그레이션을 조회합니다. 성공하면 200과 다음 응답 속성을 반환합니다:
히스토리
- GitLab 16.1에서 도입됨
이 API를 사용하여 고급 검색 마이그레이션에 대한 정보를 조회합니다.
사전 요구 사항:
- 관리자여야 합니다.
모든 고급 검색 마이그레이션 목록 조회#
GitLab 인스턴스의 모든 고급 검색 마이그레이션을 나열합니다.
GET /admin/search/migrations
예시 요청:
curl --header "PRIVATE-TOKEN: <your_access_token>" \
--url "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/migrations/:version_or_name
매개변수:
| 속성 | 타입 | 필수 | 설명 |
|---|---|---|---|
version_or_name |
integer or string | 예 | 마이그레이션의 버전 또는 이름. |
예시 요청:
curl --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://primary.example.com/api/v4/admin/search/migrations/20230503064300"
curl --header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://primary.example.com/api/v4/admin/search/migrations/BackfillProjectPermissionsInBlobsUsingPermutations"
성공하면 200과 다음 응답 속성을 반환합니다:
| 속성 | 타입 | 설명 |
|---|---|---|
version |
integer | 마이그레이션의 버전. |
name |
string | 마이그레이션의 이름. |
started_at |
datetime | 마이그레이션의 시작 날짜. |
completed_at |
datetime | 마이그레이션의 완료 날짜. |
completed |
boolean | true이면 마이그레이션이 완료된 것입니다. |
obsolete |
boolean | true이면 마이그레이션이 더 이상 사용되지 않는 것으로 표시된 것입니다. |
migration_state |
object | 저장된 마이그레이션 상태. |
예시 응답:
{
"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
}
}
