502 Плохой шлюз — ResponseWithBody

Вы просматриваете документацию Apigee Edge .
Перейдите к документации Apigee X. информация

Симптом

Клиентское приложение получает код состояния HTTP 502 Bad Gateway с кодом ошибки protocol.http.ResponseWithBody в качестве ответа на вызовы API.

Сообщение об ошибке

Клиентское приложение получает следующий код ответа:

HTTP/1.1 502 Bad Gateway

Кроме того, вы можете увидеть одно из следующих сообщений об ошибке:

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

Возможные причины

Эта ошибка возникает, если HTTP-ответ от внутреннего сервера к Apigee Edge имеет значение 204 No Content или 205 Reset Content , но содержит тело ответа и/или один или несколько следующих заголовков:

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

В соответствии со спецификациями RFC 7231, раздел 6.3.5: 204 «Нет содержимого» и RFC 7231, раздел 6.3.6: 205 «Сбросить содержимое» , ожидается, что никакой дополнительный контент не должен отправляться как часть тела полезной нагрузки ответа с кодом состояния 204 No Content или 205 Reset Content исходным сервером. Заголовки ответа, такие как Content-Length , Content-Encoding или Transfer-Encoding указывают размер, тип или формат полезных данных ответа.

Таким образом, Apigee Edge возвращает код состояния 502 Bad Gateway с кодом ошибки protocol.http.ResponseWithBody клиенту при следующих обстоятельствах:

Вот возможные причины этой ошибки:

Общие этапы диагностики

Для диагностики этой ошибки используйте один из следующих инструментов/методов:

Причина: тело ответа или заголовки с ответом 204 от внутреннего сервера.

Диагностика

1. Определите код ошибки и источник ошибки , наблюдаемой с помощью мониторинга API, инструмента трассировки или журналов доступа NGINX, как описано в разделе «Общие шаги диагностики» .
2. Если код ошибки — protocol.http.ResponseWithBody , а источник ошибки имеет значение target , то это означает, что внутренний сервер ответил кодом состояния 204 No Content или 205 Reset Content с телом ответа и/или одним из упомянутых заголовков. в разделе Возможные причины .

3. Чтобы проверить, действительно ли внутренний сервер отправил тело полезных данных ответа и/или один или несколько заголовков, упомянутых в разделе «Возможные причины» , вы можете выполнить следующие шаги:

   1. Если вы являетесь пользователем общедоступного облака и можете ли вы сделать тот же запрос API к внутреннему серверу непосредственно из любой из ваших систем.

   2. Если вы являетесь пользователем частного облака , то вы можете сделать тот же API-запрос к внутреннему серверу непосредственно от одного из процессоров сообщений, связанных с конкретной организацией и средой, где наблюдается сбой.

   3. Просмотрите ответ, полученный от внутреннего сервера, и убедитесь, что он содержит тело полезных данных ответа и/или один или несколько вышеупомянутых заголовков. Если да, то это причина этой ошибки.

      Образец №1

      Пример № 1: Ответ внутреннего сервера 204 с заголовком 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
      

      В этом примере внутренний сервер ответил кодом состояния 204 No Content и Content-Encoding: gzip

      Образец №2

      Пример № 2: Ответ внутреннего сервера 204 с заголовком 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
      

      В этом примере внутренний сервер ответил кодом состояния 204 No Content и Content-Length: 48

      Образец №3

      Пример № 3: Ответ внутреннего сервера 205 с телом ответа

      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
      

      В этом примере внутренний сервер ответил кодом состояния 205 Reset Content с телом ответа This is a sample Response.

   4. Во всех приведенных выше примерах внутренний сервер отправлял код состояния 204 No Content или 205 Reset Content вместе с телом ответа и/или одним из заголовков, упомянутых в разделе Возможные причины .
   5. Поэтому Apigee Edge отправил код состояния 502 Bad Gateway с кодом ошибки protocol.http.ResponseWithBody .

Разрешение

Убедитесь, что внутренний сервер всегда соответствует спецификации RFC 7231, раздел 6.3.6: 205 Reset Content при отправке ответа 204 No Content или 205 Reset Content в Apigee Edge. То есть внутренний сервер НЕ ДОЛЖЕН отправлять следующее как часть ответа 204 No Content или 205 Reset Content :

1. Тело полезной нагрузки ответа
2. И любой из следующих заголовков:
   1. Content-Length
   2. Content-Encoding
   3. Transfer-Encoding

Спецификация

Apigee Edge отвечает кодом состояния 502 Bad Gateway и кодом ошибки protocol.http.ResponseWithBody если внутренний сервер отправляет ответ 204 No Content или 205 Reset Content , но не соответствует следующим спецификациям RFC:

Ключевые моменты, на которые следует обратить внимание

Рекомендуемое решение — исправить внутренний сервер, чтобы он отправлял код состояния 204 No Content и 205 Reset Content без тела ответа и любых заголовков — Content-Length , Content-Encoding и Transfer-Encoding и придерживаться спецификаций RFC 7231. раздел 6.3.5: 204 No Content и RFC 7231, раздел 6.3.6: 205 Reset Content .

Если вам по-прежнему нужна помощь со стороны службы поддержки Apigee, перейдите к разделу «Необходимо собрать диагностическую информацию» .

Необходимо собрать диагностическую информацию

Соберите следующую диагностическую информацию, а затем обратитесь в службу поддержки Apigee Edge :

Если вы являетесь пользователем Public Cloud , предоставьте следующую информацию:

• Название организации
• Имя среды
• Имя API-прокси
• Полная команда curl , используемая для воспроизведения ошибки 502
• Файл трассировки запросов API

Если вы являетесь пользователем частного облака , предоставьте следующую информацию:

• Полное сообщение об ошибке, наблюдаемое для неудачных запросов
• Имя среды
• Пакет API-прокси
• Файл трассировки запросов API

• Журналы доступа NGINX /opt/apigee/var/log/edge-router/nginx/ ORG ~ ENV . PORT# _access_log

  Где: ORG , ENV и PORT# заменяются фактическими значениями.

• Системные журналы процессора сообщений /opt/apigee/var/log/edge-message-processor/logs/system.log