Sidekiq 큐 관리 API

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

GitLab 12.9에서 도입됨

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

응답에는 세 개의 필드가 있습니다:

deleted_jobs - 요청에 의해 삭제된 작업의 수입니다.
queue_size - 요청 처리 후 큐의 남은 크기입니다.
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 --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
}

도움말