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

Sidekiqキュー管理

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

指定されたメタデータに一致するSidekiqキューからジョブを削除します。

レスポンスには3つのフィールドがあります:

  1. deleted_jobs - リクエストによって削除されたジョブの数。
  2. queue_size - リクエストの処理後、キューに残っているサイズ。
  3. completed - リクエストが時間内にキュー全体を処理できたかどうか。そうでない場合、同じパラメータで再試行すると、さらにジョブが削除される可能性があります(最初のリクエストの発行後に追加されたものも含む)。

このAPIエンドポイントは、管理者のみが使用できます。

DELETE /admin/sidekiq/queues/:queue_name
属性必須説明
queue_name文字列はい削除するジョブの送信元キューの名前。
user文字列いいえジョブのスケジュールを設定したユーザー名
project文字列いいえジョブのスケジュール元となったプロジェクトのフルパス
root_namespace文字列いいえプロジェクトのルートネームスペース
subscription_plan文字列いいえルートネームスペースのサブスクリプションプラン(GitLab.comのみ)
caller_id文字列いいえジョブのスケジュールを設定するエンドポイントまたはバックグラウンドジョブ(例:ProjectsController#create/api/:version/projects/:idPostReceive
feature_category文字列いいえバックグラウンドジョブの機能カテゴリー(例:team_planningまたはcode_review
worker_class文字列いいえバックグラウンドジョブワーカーのクラス(例:PostReceiveまたはMergeWorker

queue_name以外の属性が少なくとも1つ必要です。

リクエスト例:

curl --request DELETE \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/admin/sidekiq/queues/:queue_name"

レスポンス例:

{
  "completed": true,
  "deleted_jobs": 7,
  "queue_size": 14
}