Help us learn about your current experience with the documentation. Take the survey.

Sidekiq 队列管理 API

  • 版本：Free, Premium, Ultimate
  • 产品：GitLab Self-Managed, GitLab Dedicated

从 Sidekiq 队列中删除与给定元数据匹配的任务。

响应包含三个字段：

  1. deleted_jobs - 请求删除的任务数量。
  2. queue_size - 处理请求后队列的剩余大小。
  3. completed - 请求是否能够及时处理整个队列。如果不能，使用相同参数重试可能会删除更多任务（包括在第一个请求发出后添加的任务）。

此 API 端点仅对管理员可用。

DELETE /admin/sidekiq/queues/:queue_name
属性 类型 必需 描述
queue_name string yes 要从中删除任务的队列名称
user string no 安排任务的用户的用户名
project string no 任务安排自的项目的完整路径
root_namespace string no 项目的根命名空间
subscription_plan string no 根命名空间的订阅计划 (仅限 GitLab.com)
caller_id string no 安排任务的端点或后台任务 (例如：ProjectsController#create, /api/:version/projects/:id, PostReceive)
feature_category string no 后台任务的功能类别 (例如：team_planning 或 code_review)
worker_class string no 后台任务工作进程的类 (例如：PostReceive 或 MergeWorker)

除了 queue_name 之外，至少还需要一个属性。

示例请求：

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
}