検索管理API

GitLab 16.1 で導入されました。

検索管理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_atdatetimeマイグレーションの開始日。
completed_atdatetimeマイグレーションの完了日。
completedboolean trueの場合、マイグレーションは完了します。
obsoleteboolean 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
  }
}