Messages d’erreur de l’API
Lorsqu’une demande d’API échoue en raison d’erreurs de requête ou d’erreurs de serveur, un message de réponse d’erreur est renvoyé au format JSON.
Un message de réponse d’erreur est renvoyé au format JSON, même pour les points de terminaison qui prennent en charge d’autres types MIME. Le message de réponse d’erreur comprend le message d’erreur lui-même, une description de l’erreur, un code d’erreur unique pour le point de terminaison, un message de réponse HTTP et un code de réponse HTTP.
La réponse d’erreur comprend les champs suivants :
message : le message d’erreur
Détails : un champ pour des informations supplémentaires, qui peuvent ou non être renseignées
Description : Description de l’erreur spécifique
code : code de réponse d’erreur unique
http_response :
message : message de réponse HTTP
code : code d’état de réponse HTTP
Par exemple, la requête d’API suivante tente d’obtenir des informations sur un jeu de référence inexistant appelé « test-set »
https://<host_ip>/api/reference_data/sets/test_set
Un code de réponse HTTP et le message de 404 réponse d’erreur JSON suivant sont renvoyés :
{ "message": "test_set does not exist", "details": {}, "description": "The reference set does not exist.", "code": 1002, "http_response": { "message": "We could not find the resource you requested.", "code": 404 } }
Le tableau suivant fournit plus d’informations sur les catégories d’erreurs de réponse HTTP renvoyées par l’API REST JSA :
Catégorie d’erreur HTTP |
Code de réponse HTTP |
Message de réponse HTTP |
|---|---|---|
CHOIX MULTIPLES |
300 |
|
DÉMÉNAGÉ DÉFINITIVEMENT |
301 |
|
TROUVÉ |
302 |
|
VOIR AUTRES |
303 |
|
NON MODIFIÉ |
304 |
|
UTILISER UN PROXY |
305 |
|
REDIRECTION TEMPORAIRE |
307 |
|
MAUVAISE DEMANDE |
400 |
|
NON AUTORISÉE |
401 |
|
INTERDIT |
403 |
|
INTROUVABLE |
404 |
|
MÉTHODE NON AUTORISÉE |
405 |
|
INACCEPTABLE |
406 |
|
AUTHENTIFICATION PROXY REQUISE |
407 |
|
DÉLAI DE DEMANDE D’EXPIRATION |
408 |
|
CONFLIT |
409 |
|
PARTI |
410 |
|
LONGUEUR REQUISE |
411 |
|
ECHEC DE LA CONDITION PRÉALABLE |
412 |
|
ENTITÉ DE REQUÊTE TROP GRANDE |
413 |
|
URI-DE-DEMANDE TROP LONG |
414 |
|
TYPE DE MÉDIA NON PRIS EN CHARGE |
415 |
|
LA PLAGE DEMANDÉE N’EST PAS SATISFAISANTE |
416 |
|
L’ATTENTE A ÉCHOUÉ |
417 |
|
ARGUMENTS MANQUANTS |
419 |
|
ARGUMENTS INVALIDES |
420 |
|
ENTITÉ NON TRAITABLE |
422 |
|
ERREUR INTERNE DU SERVEUR |
500 |
|
N’A PAS ÉTÉ MIS EN ŒUVRE |
501 |
|
PASSERELLE DÉFECTUEUSE |
502 |
|
SERVICE INDISPONIBLE |
503 |
|
DÉLAI D’EXPIRATION DE LA PASSERELLE |
504 |
|
VERSION HTTP NON PRISE EN CHARGE |
505 |
|
ÉCHEC D’INITIALISATION |
550 |
|