Traitement des erreurs

Cette API utilise des codes de réponse HTTP standard pour indiquer si une méthode a abouti.

HTTP les codes de réponse de l'ordre de 2xx indiquent un succès. Une réponse de l'ordre de 4xx correspond à une sorte d'échec, et une réponse de l'ordre de 5xx indique généralement une erreur interne du système qui ne peut être résolue par l'utilisateur. Le tableau suivant décrit les codes d'erreur de HTTP.

Code d'erreur HTTP	Description	Récupération
`400`	Demande incorrecte	Les paramètres d'entrée dans le corps de la demande sont incomplets ou dans un format incorrect. Veillez à inclure tous les paramètres requis dans votre demande.
`401`	Non autorisé	Vous n'êtes pas autorisé à effectuer cette demande. Connectez-vous à IBM Cloud pour obtenir un jeton IAM et réessayez. Si cette erreur persiste, contactez le propriétaire du compte pour vérifier vos droits d'accès.
`404`	Introuvable	La ressource demandée n'a pas pu être trouvée ou vous n'avez pas la permission de découvrir la ressource demandée. Si cette erreur persiste, contactez le propriétaire du compte pour vérifier vos droits d'accès.
`405`	Méthode non autorisée	La méthode HTTP fournie n'est pas prise en charge par le point final. Comparez la méthode choisie à la documentation de l'API.
`409`	Conflit	Une ressource portant ce nom existe déjà ou est déjà dans l'état demandé. Pour une nouvelle ressource, choisissez un nom unique.
`429`	Trop de demandes	Utilisation excessive de l'API. Inspectez les en-têtes de la réponse pour trouver le délai de réessai.
`500`	Erreur interne du serveur	Une condition inattendue s'est produite sur le serveur et l'a empêché de traiter la demande. Si cette erreur persiste, contactez l'équipe d'assistance.
`503`	Service indisponible	MQ on Cloud est actuellement indisponible. Votre demande n'a pas pu être traitée. Patientez quelques minutes et réessayez.

Comprendre les modèles d'erreur

Cette API suit les normes du Manuel d'erreurs de l'API IBM Cloud, ce qui garantit la cohérence entre les modèles d'erreurs. Dans la mesure du possible, les réponses aux erreurs incluront des informations permettant de comprendre la cause première de l'erreur. Par exemple :

{
  "errors": [
    {
      "code": "bad_request",
      "message": "Bad request for service instance 6b79b864-a049-4d9e-862d-99bc79759396, channel [CLOUD.APP.FAKE] is not configurable as an AMS channel for target queuemanager",
      "more_info": "https://cloud.ibm.com/apidocs/mq-on-cloud#set-certificate-ams-channels",
      "target": {
        "type": "field",
        "name": "channels"
      }
    }
  ],
  "trace": "afe0399f-d99a-4723-a5f1-6deb1e8e1703",
  "status_code": 400
}

Au minimum, les champs code, message, trace et status_code seront fournis.

Si vous devez envoyer un ticket d'assistance sur IBM Cloud®, ou AWS envoyer un ticket d'assistance sur AWS pour une erreur, incluez ces champs dans le ticket d'assistance pour permettre un débogage et une résolution rapides. Si l'on dispose de plus d'informations, par exemple sur les champs incomplets, invalides ou erronés, les champs more_info et target seront remplis afin d'orienter l'utilisateur vers le(s) domaine(s) problématique(s).