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

バッチバックグラウンド移行API

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

このAPIを使用して、バッチバックグラウンド移行を監視および管理します。

前提条件:

  • インスタンスへの管理者アクセス権が必要です。

過去20件のバッチバックグラウンド移行を一覧表示

すべてのバッチバックグラウンド移行を一覧表示します。

GET /api/v4/admin/batched_background_migrations

サポートされている属性は以下のとおりです:

属性タイプ必須説明
database文字列いいえデータベース名。mainがデフォルトです。
job_class_name文字列いいえジョブクラス名で移行をフィルタリングします。

成功した場合、200 OKと次のレスポンス属性を返します:

属性タイプ説明
column_name文字列移行が処理するカラムの名称。
created_at日時移行が作成されたタイムスタンプ。
estimated_time_remaining文字列移行が完了するまでの推定時間。nullの場合があります
id整数バッチバックグラウンド移行のID。
job_class_name文字列移行ジョブクラスの名称。
progress浮動小数点数移行の完了割合。
status文字列移行のステータス。paused、active、finished、failed、finalizing、またはfinalizedのいずれかです。
table_name文字列移行が処理するテーブルの名称。

リクエスト例:

shell
curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/admin/batched_background_migrations"

レスポンス例:

json
[
  {
    "id": 1234,
    "job_class_name": "CopyColumnUsingBackgroundMigrationJob",
    "table_name": "events",
    "column_name": "id",
    "status": "active",
    "progress": 50.0,
    "created_at": "2022-11-28T16:26:39+02:00",
    "estimated_time_remaining": "1 day"
  }
]

バッチバックグラウンド移行を取得する

バッチバックグラウンド移行を取得します。

GET /api/v4/admin/batched_background_migrations/:id

サポートされている属性は以下のとおりです:

属性タイプ必須説明
id整数はいバッチバックグラウンド移行のID。
database文字列いいえデータベース名。mainがデフォルトです。

成功した場合、200 OKと次のレスポンス属性を返します:

属性タイプ説明
column_name文字列移行が処理するカラムの名称。
created_at日時移行が作成されたタイムスタンプ。
estimated_time_remaining文字列移行が完了するまでの推定時間。
id整数バッチバックグラウンド移行のID。
job_class_name文字列移行ジョブクラスの名称。
progress浮動小数点数移行の完了割合。
status文字列移行のステータス。paused、active、finished、failed、finalizing、またはfinalizedのいずれかです。
table_name文字列移行が処理するテーブルの名称。

リクエスト例:

shell
curl --request GET \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/admin/batched_background_migrations/1234"

レスポンス例:

json
{
  "id": 1234,
  "job_class_name": "CopyColumnUsingBackgroundMigrationJob",
  "table_name": "events",
  "column_name": "id",
  "status": "active",
  "progress": 50.0,
  "created_at": "2022-11-28T16:26:39+02:00",
  "estimated_time_remaining": "1 day"
}

バッチバックグラウンド移行を一時停止する

バッチバックグラウンド移行を一時停止します。activeステータスの移行のみ一時停止できます。

PUT /api/v4/admin/batched_background_migrations/:id/pause

サポートされている属性は以下のとおりです:

属性タイプ必須説明
id整数はいバッチバックグラウンド移行のID。
database文字列いいえデータベース名。mainがデフォルトです。

成功した場合、200 OKと次のレスポンス属性を返します:

属性タイプ説明
column_name文字列移行が処理するカラムの名称。
created_at日時移行が作成されたタイムスタンプ。
estimated_time_remaining文字列移行が完了するまでの推定時間。
id整数バッチバックグラウンド移行のID。
job_class_name文字列移行ジョブクラスの名称。
progress浮動小数点数移行の完了割合。
status文字列移行のステータス。paused、active、finished、failed、finalizing、またはfinalizedのいずれかです。
table_name文字列移行が処理するテーブルの名称。

移行がactiveステータスでない場合、422 Unprocessable Entityを返します。

リクエスト例:

shell
curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/admin/batched_background_migrations/1234/pause"

レスポンス例:

json
{
  "id": 1234,
  "job_class_name": "CopyColumnUsingBackgroundMigrationJob",
  "table_name": "events",
  "column_name": "id",
  "status": "paused",
  "progress": 50.0,
  "created_at": "2022-11-28T16:26:39+02:00",
  "estimated_time_remaining": "1 day"
}

バッチバックグラウンド移行を再開する

バッチバックグラウンド移行を再開します。pausedステータスの移行のみ再開できます。

PUT /api/v4/admin/batched_background_migrations/:id/resume

サポートされている属性は以下のとおりです:

属性タイプ必須説明
id整数はいバッチバックグラウンド移行のID。
database文字列いいえデータベース名。mainがデフォルトです。

成功した場合、200 OKと次のレスポンス属性を返します:

属性タイプ説明
column_name文字列移行が処理するカラムの名称。
created_at日時移行が作成されたタイムスタンプ。
estimated_time_remaining文字列移行が完了するまでの推定時間。
id整数バッチバックグラウンド移行のID。
job_class_name文字列移行ジョブクラスの名称。
progress浮動小数点数移行の完了割合。
status文字列移行のステータス。paused、active、finished、failed、finalizing、またはfinalizedのいずれかです。
table_name文字列移行が処理するテーブルの名称。

移行がpausedステータスでない場合、422 Unprocessable Entityを返します。

リクエスト例:

shell
curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/admin/batched_background_migrations/1234/resume"

レスポンス例:

json
{
  "id": 1234,
  "job_class_name": "CopyColumnUsingBackgroundMigrationJob",
  "table_name": "events",
  "column_name": "id",
  "status": "active",
  "progress": 50.0,
  "created_at": "2022-11-28T16:26:39+02:00",
  "estimated_time_remaining": "1 day"
}