Sidekiq 큐 관리 API

Tier: Free, Premium, Ultimate Offering: Self-managed, GitLab Dedicated

주어진 메타데이터와 일치하는 Sidekiq 큐에서 작업을 삭제합니다.

응답에는 세 개의 필드가 포함됩니다:

  1. deleted_jobs - 요청에 의해 삭제된 작업의 수.

  2. queue_size - 요청 처리 후 남은 큐의 크기.

  3. completed - 요청이 제시간에 전체 큐를 처리할 수 있었는지 여부. 그렇지 않은 경우 동일한 매개변수로 재시도하면 추가 작업(첫 요청 후에 추가된 작업 포함)을 삭제할 수 있습니다.

이 API 엔드포인트는 관리자가 사용할 수 있습니다.

DELETE /admin/sidekiq/queues/:queue_name
속성 유형 필수 설명
queue_name string 예 작업을 삭제할 큐의 이름
user string 아니오 작업을 예약한 사용자의 사용자 이름
project string 아니오 작업이 예약된 프로젝트의 전체 경로
root_namespace string 아니오 프로젝트의 루트 네임스페이스
subscription_plan string 아니오 루트 네임스페이스의 구독 계획 (GitLab.com 전용)
caller_id string 아니오 작업을 예약한 엔드포인트 또는 백그라운드 작업 (예: ProjectsController#create, /api/:version/projects/:id, PostReceive)
feature_category string 아니오 백그라운드 작업의 기능 카테고리 (예: team_planning 또는 code_review)
worker_class string 아니오 백그라운드 작업 워커의 클래스 (예: PostReceive 또는 MergeWorker)

queue_name 이외에 하나 이상의 속성이 필요합니다.

curl --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/admin/sidekiq/queues/authorized_projects?user=root"

예시 응답:

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