Sidekiq 큐 관리 API
Tier: Free, Premium, Ultimate
Offering: GitLab Self-Managed, GitLab Dedicated
Offering: GitLab Self-Managed, GitLab Dedicated
요약
지정된 메타데이터와 일치하는 Sidekiq 큐의 작업을 삭제합니다. 이 API 엔드포인트는 관리자만 사용할 수 있습니다. queue_name 외에 최소 하나의 속성이 필요합니다.
Sidekiq 큐에서 작업 삭제#
지정된 메타데이터와 일치하는 Sidekiq 큐의 작업을 삭제합니다.
응답에는 세 가지 필드가 있습니다:
deleted_jobs- 요청에 의해 삭제된 작업 수.queue_size- 요청 처리 후 큐의 남은 크기.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/:id, PostReceive) |
feature_category |
문자열 | 아니요 | 백그라운드 작업의 기능 카테고리(예: team_planning 또는 code_review) |
worker_class |
문자열 | 아니요 | 백그라운드 작업 워커의 클래스(예: 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
}
