Вы просматриваете документацию по Apigee Edge.
Перейдите к документации по Apigee X. Информация
Symptom
Клиентское приложение получает код статуса HTTP 413 Request Entity Too Large
с кодом ошибки protocol.http.TooBigBody в качестве ответа на вызовы API.
Сообщение об ошибке
Клиентское приложение получает следующий код ответа:
HTTP/1.1 413 Request Entity Too Large
Кроме того, может появиться следующее сообщение об ошибке:
{
"fault":{
"faultstring":"Body buffer overflow",
"detail":{
"errorcode":"protocol.http.TooBigBody"
}
}
}Возможные причины
Эта ошибка возникает, если размер полезной нагрузки, отправленной клиентским приложением в Apigee Edge в рамках HTTP-запроса, превышает допустимый лимит в Apigee Edge .
Вот возможные причины этой ошибки :
| Причина | Описание | Инструкции по устранению неполадок, применимые к |
|---|---|---|
| Размер полезной нагрузки запроса превышает допустимый лимит | Размер полезной нагрузки, отправленной клиентским приложением в составе HTTP-запроса к Apigee Edge, превышает допустимое ограничение в Apigee Edge. | Пользователи общедоступного и частного облака Edge |
| Размер полезной нагрузки запроса превышает допустимое значение после декомпрессии | Размер полезной нагрузки, отправленной клиентским приложением в сжатом формате в составе HTTP-запроса к Apigee Edge, превышает допустимый лимит после распаковки в Apigee Edge. | Пользователи общедоступного и частного облака Edge |
Распространенные этапы диагностики
Чтобы диагностировать эту ошибку, используйте один из следующих инструментов или методов:
Мониторинг API
Чтобы диагностировать ошибку с помощью мониторинга API:
- Войдите в интерфейс Apigee Edge как пользователь с подходящей ролью.
Перейдите в организацию, в которой хотите изучить проблему.
- Перейдите на страницу Анализ > Мониторинг API > Исследование.
- Выберите период времени, в течение которого вы наблюдали ошибки.
- Чтобы сузить область поиска кода ошибки, выберите фильтр Прокси.
- Постройте график Код ошибки по оси Y и Время по оси X.
Выберите ячейку с кодом ошибки
protocol.http.TooBigBodyи кодом статуса413, как показано ниже.
Информация о коде ошибки
protocol.http.TooBigBodyбудет показана так, как описано ниже.
- Нажмите Посмотреть журналы и разверните строку с неудачным запросом. Затем в окне Журналы запишите сведения, как показано ниже :
Несжатый
Сценарий 1. Полезная нагрузка запроса отправлена в несжатом виде
В окне "Журналы" обратите внимание на следующие сведения:
- Код статуса:
413. - Источник ошибки:
proxy - Код ошибки:
protocol.http.TooBigBody. - Длина запроса(в байтах):
15360440(~15 МБ)
Если в поле Fault Source (Источник ошибки) указано значение
proxy, в поле Fault Code (Код ошибки) –protocol.http.TooBigBody, а в поле Request Length (Длина запроса) – значение больше 10 МБ, это означает, что размер полезной нагрузки HTTP-запроса от клиента превышает допустимый лимит в Apigee.Размер в сжатом виде
Сценарий 2. Полезная нагрузка запроса отправлена в сжатом виде
В окне Журналы обратите внимание на следующие сведения:
- Код статуса:
413. - Источник ошибки:
proxy - Код ошибки:
protocol.http.TooBigBody. - Длина запроса(в байтах):
15264(~15 КБ)
Если в поле Источник ошибки указано значение
proxy, в поле Код ошибки – значениеprotocol.http.TooBigBody, а в поле Длина запроса – значение меньше 10 МБ, это означает, что размер полезной нагрузки HTTP-запроса от клиента в сжатом формате меньше допустимого лимита, но больше допустимого лимита в распакованном формате, который используется в Apigee. - Код статуса:
Трассировка
Чтобы диагностировать ошибку с помощью инструмента трассировки, выполните следующие действия:
- Включите трассировку сеанса и выберите один из следующих вариантов:
- Дождитесь ошибки
413 Request Entity Too Largeили - Если вам удастся воспроизвести проблему, выполните вызов API и воспроизведите ошибку
413 Request Entity Too Large.
- Дождитесь ошибки
Убедитесь, что параметр Показать все данные о потоке включен.
- Выберите один из неудачных запросов и изучите трассировку.
- Перейдите к этапу Запрос получен от клиента.
Несжатый
Сценарий 1. Полезная нагрузка запроса отправлена в несжатом виде
Обратите внимание на следующее:
- Отсутствует заголовок Content-Encoding
- Content-Length:
15360204
Размер в сжатом виде
Сценарий 2. Полезная нагрузка запроса отправлена в сжатом виде
Обратите внимание на следующее:
- Content-Encoding:
gzip - Content-Length:
14969 - Content-Type:
application/x-gzip
- Перемещайтесь по разным этапам трассировки и находите, где произошла ошибка.
Обычно ошибка возникает на этапе после Получения запроса от клиента, как показано ниже.
- Запишите значение ошибки из трассировки. В приведенном выше примере трассировки:
- Ошибка:
Body buffer overflow - error.class:
com.apigee.errors.http.user.RequestTooLarge
- Ошибка:
Перейдите в раздел Response Sent to Client (Ответ отправлен клиенту) и запишите значения ошибки из трассировки. В приведенном ниже примере трассировки показано следующее:
- Ошибка:
413 Request Entity Too Large - Контент с ошибкой:
{"fault":{"faultstring":"Body buffer overflow","detail":{"errorcode":"protocol.http.TooBigBody"}}}
- Ошибка:
- Найдите в трассировке этап AX (запись данных аналитики) и нажмите на него.
В разделе Сведения об этапе прокрутите страницу вниз до пункта Считываемые переменные.
- Определите значение переменной client.received.content.length , которая указывает:
- Фактический размер полезной нагрузки запроса, если она отправляется в несжатом формате, и
- Размер полезной нагрузки запроса после ее распаковки Apigee, если она была отправлена в сжатом формате. В этом случае оно всегда будет совпадать с допустимым лимитом (10 МБ).
Несжатый
Сценарий 1. Полезная нагрузка запроса в несжатом виде
Переменная client.received.content.length:
15360204Размер в сжатом виде
Сценарий 2. Запрос полезной нагрузки в сжатом формате
Переменная client.received.content.length:
10489856 - В таблице ниже объясняется, почему Apigee возвращает ошибку
413в двух сценариях в зависимости от значения переменной client.received.content.length.Сценарий Значение client.received.content.length Причина ошибки Запрос сведений о полезной нагрузке в несжатом формате ~15 МБ Размер превышает допустимое значение в 10 МБ. Запрос сведений о полезной нагрузке в сжатом формате ~10 МБ После распаковки размер файла превышает допустимый
nginx
Чтобы диагностировать ошибку с помощью журналов доступа NGINX:
- Если вы используете частное облако, то можете использовать журналы доступа NGINX, чтобы определить ключевую информацию об ошибках HTTP
413. Проверьте журналы доступа NGINX:
/opt/apigee/var/log/edge-router/nginx/ORG~ENV.PORT#_access_log- Выполните поиск, чтобы узнать, возникали ли ошибки
413в течение определенного периода времени (если проблема возникла в прошлом) или есть ли запросы, которые по-прежнему завершаются с ошибкой413. - Если вы обнаружите ошибки
413с кодом X-Apigee-fault-code, соответствующим значениюprotocol.http.TooBigBody, определите значение X-Apigee-fault-source.Несжатый
Сценарий 1. Размер полезной нагрузки запроса в несжатом формате
В приведенной выше записи из журнала доступа NGINX для атрибутов X-Apigee-fault-code и X-Apigee-fault-source заданы следующие значения:
Заголовки ответа Значение X-Apigee-fault-code protocol.http.TooBigBodyX-Apigee-fault-sourc policyОбратите внимание на Длина запроса:
15360440(14,6 МБ > допустимый лимит).Размер в сжатом виде
Сценарий 2. Размер полезной нагрузки запроса в сжатом формате
В приведенной выше записи из журнала доступа NGINX для атрибутов X-Apigee-fault-code и X-Apigee-fault-source заданы следующие значения:
Заголовки ответов Значение X-Apigee-fault-code protocol.http.TooBigBodyX-Apigee-fault-source policyОбратите внимание на длину запроса:
15264(14,9 КБ < допустимого лимита).В этом случае Apigee Edge возвращает код ошибки
413, даже если длина запроса меньше допустимого значения, поскольку запрос мог быть отправлен в сжатом формате, и размер полезной нагрузки превышает ограничение после ее распаковки в Apigee Edge.
Причина: размер полезной нагрузки запроса превышает допустимый лимит.
диагностика;
- Определите код ошибки, источник ошибки и размер полезной нагрузки запроса для ошибки, обнаруженной с помощью API Monitoring, Trace Tool или журналов доступа NGINX, как описано в распространенных шагах диагностики в сценарии 1 (без сжатия).
- Если в поле Fault Source указано значение
policyилиproxy, это означает, что размер полезной нагрузки запроса, отправленного клиентским приложением в Apigee, превышает допустимый лимит в Apigee Edge. - Проверьте размер полезной нагрузки запроса, определенный на шаге 1.
- Если размер полезной нагрузки превышает допустимый лимит в 10 МБ, это и является причиной ошибки.
- Если размер полезной нагрузки меньше допустимого лимита в 10 МБ, возможно, полезная нагрузка запроса передается в сжатом формате. Go to Причина: размер полезной нагрузки запроса после распаковки превышает допустимое значение
- Вы также можете проверить, действительно ли размер полезной нагрузки запроса превышает допустимый лимит в 10 МБ, выполнив следующие действия:
- Если у вас нет доступа к запросу, отправленному клиентским приложением, перейдите к разделу Решение.
- Если у вас есть доступ к фактическому запросу, отправленному клиентским приложением, выполните следующие действия:
- Проверьте размер полезной нагрузки, переданной в запросе.
- Если вы обнаружите, что размер полезной нагрузки превышает допустимое ограничение в Apigee Edge, то это и будет причиной проблемы.
Образец запроса:
curl http://<hostalias>/testtoobigbody -k -X POST -F file=@test15mbfile -v
В приведенном выше примере размер файла
test15mbfileсоставляет примерно 15 МБ. Если вы используете другой клиент, получите его журналы, чтобы узнать размер отправляемой полезной нагрузки.
Разрешение
Выберите Разрешение.
Причина: размер полезной нагрузки запроса после распаковки превышает допустимое значение
Если полезная нагрузка запроса отправлена в сжатом формате, а заголовок запроса
Content-Encoding имеет значение gzip, , Apigee распаковывает полезную нагрузку запроса. Если в процессе распаковки Apigee обнаруживает, что размер полезной нагрузки превышает
допустимый предел (10 МБ), то распаковка прекращается и сразу возвращается ответ 413 Request Entity Too Large с кодом ошибки protocol.http.TooBigBody.
диагностика;
- Определите код ошибки,источник ошибки и размер полезной нагрузки запроса для ошибки,обнаруженной с помощью API Monitoring, Trace Tool или журналов доступа NGINX, как описано в разделе Общие шаги диагностики в сценарии 2 (сжатый).
- Если в поле Fault Source указано значение
policyилиproxy, это означает, что размер полезной нагрузки запроса, отправленного клиентским приложением в Apigee, превышает допустимый лимит в Apigee Edge. - Проверьте размер полезной нагрузки запроса, определенный на шаге 1.
- Если размер полезной нагрузки превышает допустимый лимит в 10 МБ, это и является причиной ошибки.
- Если размер полезной нагрузки меньше допустимого лимита в 10 МБ, возможно, полезная нагрузка запроса передается в сжатом формате. В этом случае проверьте размер несжатого полезного контента сжатого запроса.
- Вы можете проверить, был ли запрос от клиента отправлен в сжатом формате и превышает ли его размер в несжатом виде допустимый лимит, одним из следующих способов:
Трассировка
Чтобы выполнить проверку с помощью инструмента трассировки:
- Если вы записали трассировку для запроса, который не удалось выполнить, следуйте инструкциям в разделах Трассировка и
- Определите значение переменной client.received.content.length .
- Проверьте, содержал ли запрос от клиента заголовок Content-Encoding:
gzip.
- Если значение переменной client.received.content.length превышает 10 МБ,
допустимый лимит, а в заголовке запроса указано Content-Encoding:
gzip, то это и является причиной ошибки.
Фактический запрос
Чтобы проверить запрос:
- Если у вас нет доступа к запросу, отправленному клиентским приложением, перейдите к разделу Решение.
- Если у вас есть доступ к фактическому запросу, отправленному клиентским приложением, выполните следующие действия:
- Проверьте размер полезной нагрузки, переданной в запросе, а также заголовок
Content-Encoding, отправленный в запросе. Проверьте, не превышает ли размер несжатой полезной нагрузки допустимый лимит в Apigee Edge.
Пример запроса
curl https://<hostalias>/testtoobigbody -k -X POST -F file=@test15mbfile.gz -H "Content-Encoding: gzip" -v
В приведенном выше примере размер файла
test15mbfile.gzменьше допустимого, однако размер несжатого файлаtest15mbfileсоставляет примерно 15 МБ, а заголовокContent-Encoding–gzip.Если вы используете другой клиент, получите его журналы, чтобы узнать размер отправляемой полезной нагрузки и задано ли для заголовка
Content-Encodingзначениеgzip.
- Проверьте размер полезной нагрузки, переданной в запросе, а также заголовок
Журналы процессора сообщений
Чтобы проверить данные с помощью журналов Message Processor, выполните следующие действия:
- Если вы используете Private Cloud, то можете использовать журналы Message Processor, чтобы определить ключевую информацию об ошибках HTTP
413. Проверьте журналы Message Processor:
/opt/apigee/var/log/edge-message-processor/logs/system.logВыполните поиск, чтобы узнать, возникали ли ошибки
413за определенный период времени (если проблема возникла в прошлом) или есть ли запросы, которые по-прежнему завершаются с ошибкой413.Вы можете использовать следующие поисковые запросы:
grep -ri "chunkCount"
grep -ri "RequestTooLarge"
- Вы увидите строки, начинающиеся с
system.log, похожие на следующие (TotalReadиchunkCountмогут отличаться):2021-07-06 13:29:57,544 NIOThread@1 ERROR HTTP.SERVICE - TrackingInputChannel.checkMessageBodyTooLarge() : Message is too large. TotalRead 10489856 chunkCount 2570 2021-07-06 13:29:57,545 NIOThread@1 INFO HTTP.SERVICE - ExceptionHandler.handleException() : Exception trace: com.apigee.errors.http.user.RequestTooLarge : Body buffer overflow
- Во время распаковки, как только Message Processor определит, что общее количество прочитанных байтов превышает 10 МБ, он останавливается и выводит следующую строку:
Message is too large. TotalRead 10489856 chunkCount 2570
Это означает, что размер полезной нагрузки запроса превышает 10 МБ, и Apigee выдает ошибку
RequestTooLarge, когда размер начинает превышать лимит в 10 МБ, с кодом ошибкиprotocol.http.TooBigBody.
- Если вы записали трассировку для запроса, который не удалось выполнить, следуйте инструкциям в разделах Трассировка и
Разрешение
Фиксированный размер
Вариант 1 (рекомендуемый). Исправьте клиентское приложение, чтобы оно не отправляло полезную нагрузку, размер которой превышает допустимое ограничение.
- Проанализируйте причину, по которой определенный клиент отправляет запрос или полезную нагрузку, размер которых превышает допустимый лимит, указанный в разделе Ограничения.
Если это нежелательно, измените клиентское приложение так, чтобы оно отправляло запросы и полезную нагрузку размером меньше допустимого.
В примере выше проблему можно решить, передав файл меньшего размера, например
test5mbfile(размер полезной нагрузки – 5 МБ), как показано ниже:curl https://<host>/testtoobigbody -k -X POST -F file=@test5mbfile -v
- Если вам нужно отправить запрос или полезную нагрузку, превышающую допустимый лимит, воспользуйтесь одним из следующих вариантов.
Шаблон подписанного URL
Вариант 2 (рекомендуется). Используйте шаблон подписанных URL в Apigee JavaCallout
Для полезных нагрузок размером более 10 МБ Apigee рекомендует использовать шаблон подписанных URL в рамках Apigee JavaCallout, как показано в примере Edge Callout: Signed URL Generator на GitHub.
Потоковая передача
Вариант 3. Используйте потоковую передачу.
Если вашему прокси-серверу API нужно обрабатывать очень большие запросы и/или ответы, вы можете включить потоковую передачу в Apigee.
CwC
Вариант 4. Используйте свойство "Конверсии в магазинах", чтобы увеличить лимит буфера
Этот вариант следует использовать только в том случае, если вы не можете применить ни один из рекомендуемых вариантов, поскольку увеличение размера по умолчанию может привести к проблемам с производительностью.
Apigee предоставляет свойство CwC, которое позволяет увеличить ограничение на размер полезной нагрузки запроса и ответа. Подробнее о настройке ограничения на размер сообщений в маршрутизаторе или Message Processor…
Ограничения
Apigee ожидает, что клиентское приложение и сервер не будут отправлять полезную нагрузку, размер которой превышает допустимый лимит, указанный для Request/response size в ограничениях Apigee Edge.
- Если вы используете общедоступное облако, максимальный размер полезной нагрузки запроса и ответа соответствует ограничениям для
Request/response size, указанным в статье Ограничения Apigee Edge. - Если вы используете частное облако , то могли изменить лимит размера полезной нагрузки запроса и ответа по умолчанию (хотя это не рекомендуется). Чтобы узнать, какой максимальный размер полезной нагрузки запроса установлен в вашем аккаунте, следуйте инструкциям в разделе Как проверить текущий лимит.
Как проверить текущий лимит?
В этом разделе рассказывается, как проверить, что в процессорах сообщений для ресурса HTTPRequest.body.buffer.limit
указано новое значение.
- На компьютере Message Processor найдите свойство
HTTPRequest.body.buffer.limitв каталоге/opt/apigee/edge-message- processor/confи проверьте, какое значение было задано, с помощью следующей команды:grep -ri "HTTPRequest.body.buffer.limit" /opt/apigee/edge-message-processor/conf
- Пример результата выполнения команды:
/opt/apigee/edge-message-processor/conf/http.properties:HTTPRequest.body.buffer.limit=10m
В приведенном выше примере выходных данных обратите внимание, что свойству
HTTPRequest.body.buffer.limitзадано значение10mвhttp.properties.Это означает, что в Apigee для Private Cloud задан лимит на размер полезной нагрузки запроса в 10 МБ.
Если вам по-прежнему нужна помощь службы поддержки Apigee, перейдите к разделу Сбор диагностической информации.
Необходимо собрать диагностическую информацию
Соберите указанную ниже диагностическую информацию и обратитесь в службу поддержки Apigee Edge.
Если вы пользователь общедоступного облака, предоставьте следующую информацию:
- Название организации
- Название среды
- Название прокси API
- Полная команда curl, использованная для воспроизведения ошибки
413 - Файл трассировки для запросов к API
Если вы используете частное облако, предоставьте следующую информацию:
- Полное сообщение об ошибке, которое появляется при неудачных запросах.
- Название организации
- Название среды
- Пакет прокси API
- Файл трассировки для запросов API с ошибкой
- Полная команда curl, использованная для воспроизведения ошибки
413 Журналы доступа NGINX
/opt/apigee/var/log/edge-router/nginx/ORG~ENV.PORT#_access_logГде: ORG, ENV и PORT# заменяются фактическими значениями.
- Системные журналы Message Processor
/opt/apigee/var/log/edge-message-processor/logs/system.log