Erreurs API et pagination
Lorsqu’une requête échoue, inspectez le statut HTTP et le corps de la réponse. Gardez ce corps privé s’il contient des données de compte, de code source ou d’application.
Codes d'état
| État | Éléments à vérifier |
|---|---|
| 400 | Champs requis, encodage du corps, ID des ressources, valeurs de requête et X-Tenant-ID. |
| 401 | Jeton manquant, expiré ou incompatible. Obtenez un nouveau jeton de diagnostic si nécessaire. |
| 402 | L'abonnement de l'équipe ou le droit à des ressources pour l'opération. |
| 403 | Appartenance à l’équipe, rôle, autorisation de ressource et correspondance entre le jeton et l’équipe. |
| 404 | ID de ressource, équipe active et route. |
| 409 | État des ressources conflictuel ou une opération déjà en cours. |
| 429 | Attendez avant de réessayer et respectez Retry-After lorsqu'il est présent. |
| 5xx | Disponibilité du service. Conservez l’heure, la route et la réponse expurgée des informations sensibles pour le dépannage. |
Les opérations réussies renvoient un statut 2xx. Les suppressions CRUD générées utilisent HTTP 200 avec un message, tandis que les suppressions d’objets documentées utilisent 204. Suivez le contrat de chaque point de terminaison plutôt que de supposer un statut de réussite unique pour toutes les méthodes.
Pagination des listes
Les listes CRUD générées acceptent :
| Paramètre | Par défaut | Limite |
|---|---|---|
page | 1 | Utilisez les informations de pagination retournées pour demander d'autres pages. |
per_page | 20 | Maximum 100. |
Elles renvoient les enregistrements dans data et les métadonnées dans pagination. Les points de terminaison personnalisés peuvent utiliser d’autres formats de liste ou curseurs ; consultez leurs paramètres et leur contrat de réponse. Copiez les ID des données renvoyées pour les opérations suivantes.
Nouvelles tentatives et travail asynchrone
Relancez les lectures après une défaillance temporaire avec un délai borné. Avant de relancer une création, un déploiement, un déclenchement de workflow, un envoi de fichier ou une autre modification, inspectez l’état de la cible pour savoir si la première tentative a déjà eu un effet. Cette référence publique ne garantit pas de contrat universel de clé d’idempotence.
Une requête de compilation, de déploiement, d’aperçu ou de commande réussie peut démarrer un travail qui se terminera plus tard. Consultez son statut et ses journaux avant de considérer l’action comme terminée. Consultez vérification du déploiement et journaux et métriques.