doc-locale/fr-fr/api/admin_sidekiq_queues.md
{{< details >}}
{{< /details >}}
Supprime les jobs d'une file d'attente Sidekiq correspondant aux métadonnées données.
La réponse comporte trois champs :
deleted_jobs - le nombre de jobs supprimés par la requête.queue_size - la taille restante de la file d'attente après traitement de la requête.completed - indique si la requête a pu traiter l'intégralité de la file d'attente dans le temps imparti. Si ce n'est pas le cas, une nouvelle tentative avec les mêmes paramètres peut supprimer d'autres jobs (y compris ceux ajoutés après l'émission de la première requête).Ce point de terminaison d'API est uniquement disponible pour les administrateurs.
DELETE /admin/sidekiq/queues/:queue_name
| Attribut | Type | Obligatoire | Description |
|---|---|---|---|
queue_name | string | oui | Le nom de la file d'attente dont les jobs doivent être supprimés |
user | string | non | Le nom d'utilisateur de l'utilisateur qui a planifié les jobs |
project | string | non | Le chemin complet du projet à partir duquel les jobs ont été planifiés |
root_namespace | string | non | L'espace de nommage racine du projet |
subscription_plan | string | non | Le plan d'abonnement de l'espace de nommage racine (GitLab.com uniquement) |
caller_id | string | non | Le point de terminaison ou le job en arrière-plan qui a planifié le job (par exemple : ProjectsController#create, /api/:version/projects/:id, PostReceive) |
feature_category | string | non | La catégorie de fonctionnalité du job en arrière-plan (par exemple : team_planning ou code_review) |
worker_class | string | non | La classe du worker du job en arrière-plan (par exemple : PostReceive ou MergeWorker) |
Au moins un attribut, autre que queue_name, est requis.
Exemple de requête :
curl --request DELETE \
--header "PRIVATE-TOKEN: <your_access_token>" \
--url "https://gitlab.example.com/api/v4/admin/sidekiq/queues/:queue_name"
Exemple de réponse :
{
"completed": true,
"deleted_jobs": 7,
"queue_size": 14
}