Messages d'erreur d'API

Lorsqu'une demande d'API échoue en raison d'erreurs de demande 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 noeuds finaux 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 final, un message de réponse HTTP et un code de réponse HTTP.

La réponse d'erreur inclut les zones suivantes:

• message: message d'erreur
• details: zone 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:
  • messagemessage de réponse : HTTP message de réponse
  • code HTTP code d'état de la réponse

Par exemple, la demande d'API suivante tente d'obtenir des informations sur un ensemble de références inexistant appelé "test-set":

https://<host_ip>/api/reference_data/sets/test_set

Un HTTP404Le code de réponse et le message de 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 IBM® QRadar® REST :