502 Bad Gateway – ResponseWithBody

Vous consultez la documentation d'Apigee Edge.
Consultez la documentation Apigee X. en savoir plus

Problème constaté

L'application cliente obtient un code d'état HTTP 502 Bad Gateway avec le code d'erreur protocol.http.ResponseWithBody comme réponse aux appels d'API.

Message d'erreur

L'application cliente reçoit le code de réponse suivant:

HTTP/1.1 502 Bad Gateway

Il est également possible que l'un des messages d'erreur suivants s'affiche:

{
   "fault":{
      "faultstring":"Received 204 Response with message body",
      "detail":{
         "errorcode":"protocol.http.ResponseWithBody"
      }
   }
}

{
   "fault":{
      "faultstring":"Received 205 Response with message body",
      "detail":{
         "errorcode":"protocol.http.ResponseWithBody"
      }
   }
}

Causes possibles

Cette erreur se produit si la réponse HTTP du serveur backend à Apigee Edge est 204 No Content ou 205 Reset Content, mais elle contient le corps de la réponse et/ou un ou plusieurs des en-têtes suivants:

• Content-Length
• Content-Encoding
• Transfer-Encoding

Conformément aux spécifications RFC 7231, section 6.3.5: 204 No Content et RFC 7231, section 6.3.6: 205 Reset Content, il est normal qu'aucun contenu supplémentaire ne soit envoyé dans le corps de la réponse avec le code d'état 204 No Content ou 205 Reset Content par le serveur d'origine. Les en-têtes de réponse tels que Content-Length, Content-Encoding ou Transfer-Encoding indiquent la taille, le type ou le format de la charge utile de réponse.

Par conséquent, Apigee Edge renvoie un code d'état 502 Bad Gateway avec le code d'erreur protocol.http.ResponseWithBody au client dans les cas suivants:

	Code d'état du serveur backend
La réponse du serveur backend contient	204 Aucun contenu	205 Réinitialiser le contenu
Corps de la réponse	ERREUR	ERREUR
En-tête Content-Length (défini sur une valeur non nulle)	ERREUR	ERREUR
Content-Encoding (défini sur compatible avec l'encodage dans Apigee Edge)	ERREUR	AUCUNE ERREUR
Transfer-Encoding	ERREUR	ERREUR

Voici les causes possibles de cette erreur:

Cause	Description	Instructions de dépannage applicables
Corps ou en-têtes de la réponse avec la réponse 204 du serveur backend	Le serveur backend envoie une réponse 204 No Content ou 205 Reset Content avec un corps de réponse et/ou un ou plusieurs des en-têtes Content-Type, Content-Encoding ou Transfer-Encoding.	Utilisateurs Edge Public and Private Cloud

Étapes de diagnostic courantes

Utilisez l'un des outils ou techniques suivants pour diagnostiquer cette erreur:

Cause: corps de la réponse ou en-têtes avec la réponse 204 du serveur backend

Diagnostic

1. Déterminez le code d'erreur et la source de l'erreur de l'erreur observée à l'aide de la surveillance des API, de l'outil Trace ou des journaux d'accès NGINX, comme expliqué dans la section Étapes de diagnostic courantes.
2. Si le code d'erreur est protocol.http.ResponseWithBody et que la source d'erreur a la valeur target, cela signifie que le serveur backend a répondu avec un code d'état 204 No Content ou 205 Reset Content avec le corps de la réponse et/ou l'un des en-têtes mentionnés dans Causes possibles.

3. Pour vérifier si le serveur backend a effectivement envoyé un corps de charge utile de réponse et/ou un ou plusieurs des en-têtes mentionnés dans Causes possibles, vous pouvez procéder comme suit:

   1. Si vous êtes un utilisateur de cloud public et que vous pouvez envoyer la même requête API au serveur backend directement à partir de l'un de vos systèmes.

   2. Si vous êtes un utilisateur du cloud privé, vous pouvez envoyer la même requête API au serveur backend directement à partir de l'un des processeurs de messages associés à l'organisation et à l'environnement spécifiques dans lesquels l'échec est observé.

   3. Examinez la réponse reçue du serveur backend et vérifiez qu'elle contient un corps de charge utile de réponse et/ou un ou plusieurs des en-têtes mentionnés ci-dessus. Si oui, c'est la cause de l'erreur.

      Exemple 1

      Exemple n° 1: Réponse 204 du serveur backend avec en-tête Content-Encoding

      curl -v "https://BACKEND_SERVER_HOST_NAME/PATH" -H "HEADER: VALUE" -X HTTP_REQUEST_METHOD
      

      …
      < HTTP/1.1 204 No Content
      < Content-Encoding: gzip
      < Date: Tue, 31 Jul 2021 21:41:13 GMT
      < Connection: keep-alive
      

      Dans cet exemple, le serveur backend a répondu avec le code d'état 204 No Content et Content-Encoding: gzip.

      Exemple 2

      Exemple n° 2: Réponse 204 du serveur backend avec l'en-tête Content-Length

      curl -v "https://BACKEND_SERVER_HOST_NAME/PATH" -H "HEADER: VALUE" -X HTTP_REQUEST_METHOD
      

      …
      < HTTP/1.1 204 No Content
      < Content-Length: 48
      < Date: Tue, 31 Jul 2021 21:41:13 GMT
      < Connection: keep-alive
      

      Dans cet exemple, le serveur backend a répondu avec le code d'état 204 No Content et Content-Length: 48.

      Exemple 3

      Exemple n° 3: Réponse 205 du serveur backend avec corps de la réponse

      curl -v "https://BACKEND_SERVER_HOST_NAME/PATH" -H "HEADER: VALUE" -X HTTP_REQUEST_METHOD
      

      …
      < HTTP/1.1 205 Reset Content
      < Date: Sat, 31 Jul 2021 17:14:09 GMT
      < Content-Length: 12
      < Content-Type: text/plain; charset=utf-8
      <
      * Connection #0 to host X.X.X.X left intact
      This is a sample Response
      

      Dans cet exemple, le serveur backend a renvoyé le code d'état 205 Reset Content avec le corps de la réponse This is a sample Response..

   4. Dans tous les exemples ci-dessus, le serveur backend a envoyé le code d'état 204 No Content ou 205 Reset Content avec le corps de la réponse et/ou l'un des en-têtes mentionnés dans les causes possibles.
   5. Par conséquent, Apigee Edge a envoyé le code d'état 502 Bad Gateway avec le code d'erreur protocol.http.ResponseWithBody.

Résolution

Assurez-vous que le serveur backend respecte toujours la spécification RFC 7231, section 6.3.6: 205 Réinitialiser le contenu, lorsque vous envoyez la réponse 204 No Content ou 205 Reset Content à Apigee Edge. Autrement dit, le serveur backend NE DOIT PAS envoyer les éléments suivants dans une réponse 204 No Content ou 205 Reset Content:

1. Corps de la charge utile de la réponse
2. Et l'un des en-têtes suivants :
   1. Content-Length
   2. Content-Encoding
   3. Transfer-Encoding

Spécification

Apigee Edge renvoie le code d'état 502 Bad Gateway et le code d'erreur protocol.http.ResponseWithBody si le serveur backend envoie une réponse 204 No Content ou 205 Reset Content, mais ne respecte pas les spécifications RFC suivantes:

Spécification
RFC 7231, section 6.3.5: 204 Pas de contenu
RFC 7231, section 6.3.6: 205 Réinitialiser le contenu

Points clés à noter

La solution recommandée consiste à corriger le serveur backend pour qu'il envoie les codes d'état 204 No Content et 205 Reset Content sans corps de réponse ni aucun des en-têtes (Content-Length, Content-Encoding et Transfer-Encoding), et conforme aux spécifications RFC 7231, section 6.3.5: 204 No Content et RFC 7231, section 6.3.6: 205 Reset Content.

Si vous avez encore besoin d'aide de l'assistance Apigee, consultez la section Vous devez recueillir des informations de diagnostic.

Vous devez collecter des informations de diagnostic

Rassemblez les informations de diagnostic suivantes, puis contactez l'assistance Apigee Edge:

Si vous êtes un utilisateur de cloud public, fournissez les informations suivantes:

• Le nom de l'organisation.
• Nom de l'environnement
• Nom du proxy d'API
• Complétez la commande curl permettant de reproduire l'erreur 502.
• Fichier de suivi des requêtes API

Si vous êtes un utilisateur du Private Cloud, fournissez les informations suivantes:

• Message d'erreur complet observé pour les requêtes ayant échoué
• Nom de l'environnement
• Groupe de proxys d'API
• Fichier de suivi des requêtes API

• Journaux d'accès NGINX /opt/apigee/var/log/edge-router/nginx/ORG~ENV.PORT#_access_log

  Où:ORG, ENV et PORT# sont remplacés par des valeurs réelles.

• Journaux système du processeur de messages /opt/apigee/var/log/edge-message-processor/logs/system.log