502 Nieprawidłowa brama – ResponseWithBody

Wyświetlasz dokumentację Apigee Edge.
Otwórz dokumentację Apigee X. info

Krótki opis problemu

Aplikacja kliencka otrzymuje kod stanu HTTP 502 Bad Gateway z kodem błędu protocol.http.ResponseWithBody w odpowiedzi na wywołania interfejsu API.

Komunikat o błędzie

Aplikacja kliencka otrzymuje ten kod odpowiedzi:

HTTP/1.1 502 Bad Gateway

Dodatkowo możesz zobaczyć jeden z tych komunikatów o błędach:

{
   "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"
      }
   }
}

Możliwe przyczyny

Ten błąd występuje, jeśli odpowiedź HTTP z serwera backendu do Apigee Edge to 204 No Content lub 205 Reset Content, ale zawiera treść odpowiedzi lub co najmniej 1 z tych nagłówków:

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

Zgodnie ze specyfikacjami RFC 7231, sekcja 6.3.5: 204 No Content i RFC 7231, sekcja 6.3.6: 205 Reset Content, serwer pierwotny nie powinien wysyłać żadnej dodatkowej treści w treści ładunku odpowiedzi z kodem stanu 204 No Content lub 205 Reset Content. Nagłówki odpowiedzi takie jak Content-Length, Content-Encoding lub Transfer-Encoding wskazują rozmiar, typ lub format ładunku odpowiedzi.

Dlatego w tych okolicznościach Apigee Edge zwraca do klienta kod stanu 502 Bad Gateway z kodem błędu protocol.http.ResponseWithBody:

Oto możliwe przyczyny tego błędu:

Typowe czynności diagnostyczne

Aby zdiagnozować ten błąd, użyj jednego z tych narzędzi lub technik:

Przyczyna: treść odpowiedzi lub nagłówki z odpowiedzią 204 z serwera backendu

Diagnostyka

1. Określ Kod błędu i Źródło błędu zaobserwowanego błędu za pomocą monitorowania interfejsów API , narzędzia Trace lub logów dostępu NGINX zgodnie z opisem w sekcji Typowe czynności diagnostyczne.
2. Jeśli Kod błędu to protocol.http.ResponseWithBody, a Źródło błędu ma wartość target, oznacza to, że serwer backendu odpowiedział kodem stanu 204 No Content lub 205 Reset Content z treścią odpowiedzi lub jednym z nagłówków wymienionych w sekcji Możliwe przyczyny.

3. Aby sprawdzić, czy serwer backendu rzeczywiście wysłał treść ładunku odpowiedzi lub co najmniej 1 z nagłówków wymienionych w sekcji Możliwe przyczyny, wykonaj te czynności:

   1. Jeśli jesteś użytkownikiem chmury publicznej i możesz wysłać to samo żądanie do interfejsu API bezpośrednio z dowolnego systemu.

   2. Jeśli jesteś użytkownikiem chmury prywatnej, możesz wysłać to samo żądanie do interfejsu API bezpośrednio z jednego z procesorów komunikatów powiązanych z konkretną organizacją i środowiskiem, w którym wystąpił błąd.

   3. Sprawdź odpowiedź otrzymaną z serwera backendu i upewnij się, że zawiera ona a treść ładunku odpowiedzi lub co najmniej 1 z wymienionych powyżej nagłówków. Jeśli tak, to jest to przyczyna tego błędu.

      Przykład 1

      Przykład 1. Odpowiedź serwera backendu 204 z nagłówkiem 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
      

      W tym przykładzie serwer backendu odpowiedział kodem stanu 204 No Content i Content-Encoding: gzip

      Przykład 2

      Przykład 2. Odpowiedź serwera backendu 204 z nagłówkiem 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
      

      W tym przykładzie serwer backendu odpowiedział z 204 No Content kodem stanu i Content-Length: 48

      Przykład 3

      Przykład 3. Odpowiedź serwera backendu 205 z treścią odpowiedzi

      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
      

      W tym przykładzie serwer backendu odpowiedział z 205 Reset Content kodem stanu z treścią odpowiedzi This is a sample Response.

   4. We wszystkich powyższych przykładach serwer backendu wysłał 204 No Content lub 205 Reset Content kod stanu z treścią odpowiedzi lub jednym z nagłówków wymienionych w sekcji Możliwe przyczyny.
   5. Dlatego Apigee Edge wysłał 502 Bad Gateway kod stanu z kodem błędu protocol.http.ResponseWithBody.

Rozdzielczość

Upewnij się, że serwer backendu zawsze przestrzega specyfikacji RFC 7231, sekcja 6.3.6: 205 Reset Content, gdy wysyła odpowiedź 204 No Content lub 205 Reset Content do Apigee Edge. Oznacza to, że serwer backendu NIE MOŻE wysyłać tych elementów w ramach odpowiedzi 204 No Content lub 205 Reset Content:

1. Treść ładunku odpowiedzi
2. I dowolny z tych nagłówków:
   1. Content-Length
   2. Content-Encoding
   3. Transfer-Encoding

Specyfikacja

Apigee Edge odpowiada kodem stanu 502 Bad Gateway i kodem błędu protocol.http.ResponseWithBody jeśli serwer backendu wysyła odpowiedź 204 No Content lub 205 Reset Content ale nie przestrzega tych specyfikacji RFC:

Ważne uwagi

Zalecamy naprawienie serwera backendu, aby wysyłał kod stanu 204 No Content i 205 Reset Content bez treści odpowiedzi i bez żadnego z tych nagłówków: Content-Length, Content-Encoding i Transfer-Encoding, oraz aby przestrzegał specyfikacji RFC 7231, sekcja 6.3.5: 204 No Content i RFC 7231, sekcja 6.3.6: 205 Reset Content.

Jeśli nadal potrzebujesz pomocy zespołu pomocy Apigee, zapoznaj się z sekcją Informacje diagnostyczne, które musisz zebrać.

Informacje diagnostyczne, które musisz zebrać

Zbierz te informacje diagnostyczne, a potem skontaktuj się z zespołem pomocy Apigee Edge:

Jeśli jesteś użytkownikiem chmury publicznej, podaj te informacje:

• Nazwa organizacji
• Nazwa środowiska
• Nazwa proxy interfejsu API
• Pełne polecenie curl użyte do odtworzenia błędu 502
• Plik śledzenia żądań do interfejsu API

Jeśli jesteś użytkownikiem chmury prywatnej, podaj te informacje:

• Pełny komunikat o błędzie zaobserwowany w przypadku nieudanych żądań
• Nazwa środowiska
• Pakiet proxy interfejsu API
• Plik śledzenia żądań do interfejsu API

• Logi dostępu NGINX /opt/apigee/var/log/edge-router/nginx/ORG~ENV.PORT#_access_log

  Gdzie: ORG, ENV i PORT# są zastępowane rzeczywistymi wartościami.

• Dzienniki systemowe procesora komunikatów /opt/apigee/var/log/edge-message-processor/logs/system.log