502 Bad Gateway – Réponse 405 sans autorisation d'en-tête

Surveillance des API

Pour diagnostiquer l'erreur à l'aide de la surveillance des API :

1. Connectez-vous à l'interface utilisateur Edge en tant qu'utilisateur disposant d'un rôle approprié.

2. Basculez vers l'organisation dans laquelle vous souhaitez examiner le problème.

   
3. Accédez à la page Analyze > API Monitoring > Investigate (Analyser > Surveillance des API > Examiner).
4. Sélectionnez la période spécifique au cours de laquelle vous avez observé les erreurs.

5. Tracez le code d'erreur par rapport à l'heure.

6. Sélectionnez une cellule contenant le code d'erreur protocol.http.Response405WithoutAllowHeader, comme illustré ci-dessous :

   

7. Les informations sur le code d'erreur protocol.http.Response405WithoutAllowHeader s'affichent comme suit :

   

8. Cliquez sur View logs (Afficher les journaux) et développez l'une des requêtes ayant échoué pour afficher plus d'informations.

   
9. Dans la fenêtre Logs (Journaux), notez les informations suivantes :
   • Code d'état : 502
   • Source de l'erreur : target
   • Code d'erreur : protocol.http.Response405WithoutAllowHeader.
10. Si la source de l'erreur est target et que le code d'erreur est protocol.http.Response405WithoutAllowHeader, cela indique que le serveur backend a répondu avec le code d'état 405 Method Not Allowed sans l' en-tête Allow.

Outil Trace

Pour diagnostiquer l'erreur à l'aide de l'outil Trace :

1. Activez la session de trace et
   • attendez que l'erreur 502 Bad Gateway se produise, ou
   • si vous pouvez reproduire le problème, effectuez l'appel d'API pour le reproduire - 502 Bad Gateway erreur

2. Assurez-vous que l'option Show all FlowInfos (Afficher toutes les FlowInfos) est activée :

   
3. Sélectionnez l'une des requêtes ayant échoué et examinez la trace.
4. Parcourez les différentes phases de la trace et identifiez l'endroit où l'échec s'est produit.

5. L'erreur se trouve généralement dans un flux après la phase Request sent to target server comme illustré ci-dessous :

   

6. Notez la valeur de l'erreur dans la trace.

   L'exemple de trace ci-dessus indique l'erreur Received 405 Response without Allow Header. Étant donné que l'erreur est générée par Apigee après l'envoi de la requête au serveur backend, cela indique que le serveur backend a envoyé le code d'état de réponse 405 sans l'en-tête Allow.

7. Accédez à la phase AX (Analytics Data Recorded) de la trace et cliquez dessus.

8. Faites défiler la page jusqu'à la section Error / Response Headers (En-têtes d'erreur/de réponse) du panneau Phase Details (Détails de la phase) et déterminez les valeurs de X-Apigee-fault-code et X-Apigee-fault-source , comme illustré ci-dessous :

   
9. Les valeurs de X-Apigee-fault-code et X-Apigee-fault-source sont respectivement protocol.http.Response405WithoutAllowHeader et target, ce qui indique que cette erreur est due au fait que le backend a envoyé le code d'état de réponse 405 sans l'en-tête Allow.

   En-têtes de réponse	Valeur
   X-Apigee-fault-code	protocol.http.Response405WithoutAllowHeader
   X-Apigee-fault-source	target

NGINX

Pour diagnostiquer l'erreur à l'aide des journaux d'accès NGINX :

1. Si vous êtes un utilisateur de Private Cloud, vous pouvez utiliser les journaux d'accès NGINX pour déterminer les informations clés sur les erreurs HTTP 502.

2. Vérifiez les journaux d'accès NGINX :

   /opt/apigee/var/log/edge-router/nginx/ORG~ORG.PORT#_access_log

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

3. Recherchez les éventuelles erreurs 502 avec le code d’erreur protocol.http.Response405WithoutAllowHeader pendant une durée spécifique (si le problème s’est produit dans le passé) ou si des requêtes échouent toujours avec 502.

4. Si vous trouvez des 502 erreurs dont le X-Apigee-fault-code correspond à la valeur protocol.http.Response405WithoutAllowHeader, déterminez la valeur de X-Apigee-fault-source.

   Exemple d'erreur 502 dans le journal d'accès NGINX :

   

   L'entrée d'exemple ci-dessus du journal d'accès NGINX présente les valeurs suivantes pour X-Apigee- fault-code et X-Apigee-fault-source:

   En-têtes de réponse	Valeur
   X-Apigee-fault-code	protocol.http.Response405WithoutAllowHeader
   X-Apigee-fault-source	target

Serveur backend

Option 1 : Corrigez le serveur backend pour qu'il envoie le code d'état 405 avec l'en-tête "Allow" :

1. Assurez-vous que le serveur backend respecte toujours la spécification RFC 7231, section 6.5.5 : 405 Method Not Allowed et envoie le code d'état 405 en incluant la liste des méthodes autorisées dans un en-tête Allow, comme illustré ci-dessous :

   Allow: HTTP_METHODS

2. Par exemple, si votre serveur backend autorise les méthodes GET, POST et HEAD, vous devez vous assurer que l'en-tête Allow les contient comme suit :

   Allow: GET, POST, HEAD

Gestion des erreurs

Option 2 : Utilisez la gestion des erreurs pour envoyer le code d'état 405 avec l'en-tête "Allow" à partir de votre proxy d'API :

Si le serveur backend renvoie le code d'état 405 sans l'en-tête Allow , vous pouvez utiliser la gestion des erreurs pour répondre avec le code d'état 405 et l'en-tête Allow à partir de votre proxy d'API, comme suit :

1. Créez une règle telle que la règle AssignMessage ou la règle RaiseFault et définissez le code d'état sur 405 avec l'en-tête Allow et un message personnalisé.

   Exemple de règle AssignMessage pour envoyer 405 avec l'en-tête "Allow" :

   <AssignMessage async="false" continueOnError="false" enabled="true" name="AM-405WithAllowHeader">
       <DisplayName>AM-405WithAllowHeader</DisplayName>
       <Set>
           <Payload contentType="application/json">{"Specified method is not allowed. Please use one of the methods mentioned in the Allow header."}</Payload>
           <StatusCode>405</StatusCode>
           <ReasonPhrase>Method Not Allowed</ReasonPhrase>
       </Set>
       <Add>
           <Headers>
               <Header name="Allow">GET, POST, HEAD</Header>
           </Headers>
       </Add>
       <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
       <AssignTo createNew="false" transport="http" type="request"/>
   </AssignMessage>

2. Créez un FaultRule dans le TargetEndpoint, qui appelle la règle lors de la réception de l'erreur 502 avec le code d'erreur protocol.http.Response405WithoutAllowHeader.

   Exemple de configuration TargetEndpoint montrant FaultRule :

   <TargetEndpoint name="default">
   ...
       <FaultRules>
          <FaultRule name="405WithoutAllowHeader">
               <Step>
                   <Name>AM-405WithAllowHeader</Name>
               </Step>
               <Condition>(fault.name = "Response405WithoutAllowHeader")</Condition>
           </FaultRule>
       </FaultRules>

3. Enregistrez ces modifications dans une nouvelle révision de votre proxy d'API et déployez la révision.
4. Effectuez les appels d'API et vérifiez que vous obtenez le 405 code d'état avec l' Allow en-tête.

Configurer la propriété

Option 3 : Configurez la propriété dans le processeur de messages pour empêcher Apigee Edge de renvoyer une erreur 502

1. Si vous êtes un utilisateur de Private Cloud, vous pouvez définir la propriété HTTP.ignore.allow_header.for.405 sur true pour empêcher Apigee Edge de générer une erreur 502, même si le serveur backend répond avec le code d'état 405 sans l'en-tête Allow, à l'aide du guide pratique : Configurer l'en-tête "Allow" à ignorer pour la propriété 405 dans les processeurs de messages.
2. Si vous êtes un utilisateur de Public Cloud, veuillez contacter l'assistance Apigee Edge