ドキュメントに関する現在のご利用体験についてお聞かせください。アンケートにご協力ください。
バッチバックグラウンド移行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 | 文字列 | 移行が処理するテーブルの名称。 |
リクエスト例:
curl --request GET \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/admin/batched_background_migrations"レスポンス例:
[
{
"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 | 文字列 | 移行が処理するテーブルの名称。 |
リクエスト例:
curl --request GET \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/admin/batched_background_migrations/1234"レスポンス例:
{
"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を返します。
リクエスト例:
curl --request PUT \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/admin/batched_background_migrations/1234/pause"レスポンス例:
{
"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を返します。
リクエスト例:
curl --request PUT \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/admin/batched_background_migrations/1234/resume"レスポンス例:
{
"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"
}Was this page helpful?