正式なドキュメントは英語版であり、この日本語訳はAI支援翻訳により作成された参考用のものです。日本語訳の一部の内容は人間によるレビューがまだ行われていないため、翻訳のタイミングにより英語版との間に差異が生じることがあります。最新かつ正確な情報については、英語版をご参照ください。

プロジェクトリポジトリストレージ移動API

  • プラン: Free、Premium、Ultimate
  • 提供形態: GitLab Self-Managed、GitLab Dedicated

Wikiやデザインリポジトリを含むプロジェクトリポジトリは、ストレージ間で移行できます。このAPIは、たとえば、Gitaly Cluster (Praefect)への移行に役立ちます。

プロジェクトリポジトリストレージの移行が処理されると、さまざまな状態に移行します。stateの値は次のとおりです:

  • initial: レコードは作成されましたが、バックグラウンドジョブはまだスケジュールされていません。
  • scheduled: バックグラウンドジョブがスケジュールされました。
  • started: プロジェクトリポジトリは、宛先ストレージにコピーされています。
  • replicated: プロジェクトが移動されました。
  • failed: プロジェクトリポジトリのコピーに失敗したか、チェックサムが一致しませんでした。
  • finished: プロジェクトが移動され、ソースストレージのリポジトリが削除されました。
  • cleanup failed: プロジェクトは移動されましたが、ソースストレージのリポジトリを削除できませんでした。

データの整合性を確保するために、プロジェクトは移動中、一時的な読み取り専用状態になります。この間、新しいコミットをプッシュしようとすると、The repository is temporarily read-only. Please try again later.というメッセージが表示されます。

このAPIを使用するには、認証する必要があります（管理者として）。

他のリポジトリタイプについては、以下を参照してください:

すべてのプロジェクトリポジトリストレージの移動を取得します

GET /project_repository_storage_moves

APIの結果はページネーションされるため、デフォルトでは、GETリクエストは一度に20件の結果を返します。

リクエスト例:

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

レスポンス例:

[
  {
    "id": 1,
    "created_at": "2020-05-07T04:27:17.234Z",
    "state": "scheduled",
    "source_storage_name": "default",
    "destination_storage_name": "storage2",
    "project": {
      "id": 1,
      "description": null,
      "name": "project1",
      "name_with_namespace": "John Doe2 / project1",
      "path": "project1",
      "path_with_namespace": "namespace1/project1",
      "created_at": "2020-05-07T04:27:17.016Z"
    }
  }
]

プロジェクトのすべてのリポジトリストレージの移動を取得します

GET /projects/:project_id/repository_storage_moves

APIの結果はページネーションされるため、デフォルトでは、GETリクエストは一度に20件の結果を返します。

パラメータは以下のとおりです:

属性型必須説明
project_id整数はいプロジェクトのID

リクエスト例:

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

レスポンス例:

[
  {
    "id": 1,
    "created_at": "2020-05-07T04:27:17.234Z",
    "state": "scheduled",
    "source_storage_name": "default",
    "destination_storage_name": "storage2",
    "project": {
      "id": 1,
      "description": null,
      "name": "project1",
      "name_with_namespace": "John Doe2 / project1",
      "path": "project1",
      "path_with_namespace": "namespace1/project1",
      "created_at": "2020-05-07T04:27:17.016Z"
    }
  }
]

単一のプロジェクトリポジトリストレージの移動を取得します

GET /project_repository_storage_moves/:repository_storage_id

パラメータは以下のとおりです:

属性型必須説明
repository_storage_id整数はいプロジェクトリポジトリストレージの移動のID

リクエスト例:

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

レスポンス例:

{
  "id": 1,
  "created_at": "2020-05-07T04:27:17.234Z",
  "state": "scheduled",
  "source_storage_name": "default",
  "destination_storage_name": "storage2",
  "project": {
    "id": 1,
    "description": null,
    "name": "project1",
    "name_with_namespace": "John Doe2 / project1",
    "path": "project1",
    "path_with_namespace": "namespace1/project1",
    "created_at": "2020-05-07T04:27:17.016Z"
  }
}

プロジェクトの単一のリポジトリストレージの移動を取得します

GET /projects/:project_id/repository_storage_moves/:repository_storage_id

パラメータは以下のとおりです:

属性型必須説明
project_id整数はいプロジェクトのID
repository_storage_id整数はいプロジェクトリポジトリストレージの移動のID

リクエスト例:

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/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",
  "project": {
    "id": 1,
    "description": null,
    "name": "project1",
    "name_with_namespace": "John Doe2 / project1",
    "path": "project1",
    "path_with_namespace": "namespace1/project1",
    "created_at": "2020-05-07T04:27:17.016Z"
  }
}

プロジェクトのリポジトリストレージの移動をスケジュールします

POST /projects/:project_id/repository_storage_moves

パラメータは以下のとおりです:

属性型必須説明
project_id整数はいプロジェクトのID
destination_storage_name文字列いいえ宛先ストレージシャードの名前。ストレージが指定されていない場合、ストレージウェイトに基づいて自動的に選択されます

リクエスト例:

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

レスポンス例:

{
  "id": 1,
  "created_at": "2020-05-07T04:27:17.234Z",
  "state": "scheduled",
  "source_storage_name": "default",
  "destination_storage_name": "storage2",
  "project": {
    "id": 1,
    "description": null,
    "name": "project1",
    "name_with_namespace": "John Doe2 / project1",
    "path": "project1",
    "path_with_namespace": "namespace1/project1",
    "created_at": "2020-05-07T04:27:17.016Z"
  }
}

ストレージシャード上のすべてのプロジェクトのリポジトリストレージの移動をスケジュールします

ソースストレージシャードに保存されている各プロジェクトリポジトリのリポジトリストレージの移動をスケジュールします。このエンドポイントは、すべてのプロジェクトを一度に移行します。

POST /project_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"}' \
  --url "https://gitlab.example.com/api/v4/project_repository_storage_moves"

レスポンス例:

{
  "message": "202 Accepted"
}