Вы просматриваете документацию по Apigee Edge.
Перейдите к документации по Apigee X. Информация
Symptom
Клиентское приложение получает код статуса HTTP 500 Internal Server Error с кодом ошибки protocol.http.BadFormData в качестве ответа на вызовы API.
Сообщение об ошибке
Клиентское приложение получает следующий код ответа:
HTTP/1.1 500 Internal Server Error
Кроме того, может появиться следующее сообщение об ошибке:
{
"fault":{
"faultstring":"Bad Form Data",
"detail":{
"errorcode":"protocol.http.BadFormData"
}
}
}Данные форм
Прежде чем мы перейдем к устранению неполадок, давайте разберемся, что такое данные форм.
Данные формы – это информация, которую пользователь обычно предоставляет через HTML-форму с такими элементами, как текстовое поле, кнопка или флажок. Данные формы обычно отправляются в виде набора пар "ключ-значение" в составе HTTP-запросов или ответов.
Передача данных из форм
- Content-Type: application/x-www-form-urlencoded
- Если размер данных формы небольшой, они отправляются в виде пар "ключ-значение" со следующими параметрами:
- Символы в обоих ключах закодированы в соответствии с правилами, описанными в Формы – раздел 17.13.4.1.
- Заголовок
Content-Type: application/x-www-form-urlencoded
Пример запроса с данными формы
curl https://HOSTALIAS/somepath -H "Content-Type: application/x-www-form-urlencoded" -d "username=abc@google.com&pasword=secret123"
- Все небуквенно-цифровые символы в ключах и значениях
кодируются в процентах, то есть представляются в виде триплета символов
%HH, состоящего из знака процента, за которым следуют две шестнадцатеричные цифры, представляющие код ASCII определенного символа. - Таким образом, хотя знак процента (
%) разрешен в данных формы, он интерпретируется как начало специальной управляющей последовательности. Поэтому, если данные формы должны содержать знак процента (%) в ключе или значении, его следует передавать как%25,, что представляет собой код ASCII для знака процента (%).
- Если размер данных формы небольшой, они отправляются в виде пар "ключ-значение" со следующими параметрами:
- Content-Type: multipart/form-data
Если вам нужно передать большой объем двоичных данных или текста, содержащего символы, не входящие в набор ASCII, вы можете отправить данные с помощью
Content-Type:multipart/form-data, как описано в Forms - Section 17.13.4.2.
Возможные причины
Эта ошибка возникает, только если соблюдены все следующие условия:
- HTTP-запрос, отправленный клиентом в Apigee Edge, содержит:
Content-Type: application/x-www-form-urlencodedи- Данные формы с символом процента (
%) или символом процента (%), за которым следуют недопустимые шестнадцатеричные символы, которые не разрешены согласно Forms - Section 17.13.4.1.
Прокси API в Apigee Edge считывает определенные параметры формы, содержащие любые символы, которые не разрешены для использования в потоке запросов, с помощью политики ExtractVariables или AssignMessage.
Например, если данные формы содержат знак процента (
%) в исходном виде (без кодирования) или знак процента (%), за которым следуют недопустимые шестнадцатеричные символы в ключе и/или значении, то вы получите эту ошибку.Вот возможные причины этой ошибки:
Причина Описание Инструкции по устранению неполадок, применимые к Параметры формы в запросе содержат недопустимые символы Параметры формы, переданные в составе HTTP-запроса клиента, содержат символы, которые не разрешены. Пользователи общедоступного и частного облака Edge
Распространенные этапы диагностики
Чтобы диагностировать эту ошибку, используйте один из следующих инструментов или методов:
Мониторинг API
Чтобы диагностировать ошибку с помощью мониторинга API:
- Войдите в интерфейс Apigee Edge как пользователь с подходящей ролью.
Перейдите к организации, в которой хотите изучить проблему.
- Перейдите на страницу Анализ > Мониторинг API > Исследование.
- Выберите период времени, в течение которого вы наблюдали ошибки.
Постройте график Код ошибки по оси Y и Время по оси X.
Выберите ячейку с кодом ошибки
protocol.http.BadFormData, как показано ниже:Посмотреть увеличенное изображение
Информация о коде неисправности
protocol.http.BadFormDataбудет показана, как на изображении ниже:Посмотреть увеличенное изображение
Нажмите Посмотреть журналы и разверните строку с неудачным запросом.
- В окне Журналы обратите внимание на следующие сведения:
- Код статуса:
500. - Источник ошибки:
proxy - Код ошибки:
protocol.http.BadFormData - Правила обработки ошибок:
extractvariables/EV-ExtractFormParams
- Код статуса:
- Если в поле Источник ошибки указано значение
proxy, в поле Код ошибки –protocol.http.BadFormData, а в поле Правило ошибки – непустое значение, это означает, что ошибка произошла, когда правило, указанное в поле Правило ошибки, считывало или извлекало данные формы (параметры формы), в которых есть символы, недопустимые для использования. - В этом примере X-Apigee-fault-policy имеет значение
extractvariables/EV- ExtractFormParams,, что означает, что при чтении или извлечении параметров формы произошла ошибка в правиле ExtractVariables с именем EV-ExtractFormParams.
Инструмент "Трассировка"
Чтобы диагностировать ошибку с помощью инструмента трассировки, выполните следующие действия:
- Включите сеанс трассировки и один из следующих вариантов:
- Дождитесь ошибки
500 Internal Server Errorили - Если проблему можно воспроизвести, сделайте вызов API, чтобы воспроизвести ее.
500 Internal Server Error
- Дождитесь ошибки
Убедитесь, что включен параметр Показывать все FlowInfo:
- Выберите один из неудачных запросов и изучите трассировку.
- Перемещайтесь по разным этапам трассировки и найдите, где произошла ошибка.
Как правило, ошибка указывается в одном из правил, как показано ниже.
В приведенном выше примере трассировки обратите внимание, что сбой произошел в правиле ExtractVariables с названием
EV-ExtractFormParams.Перейдите к потоку Ошибка после правила, которое не удалось применить:
- Запишите следующие значения из трассировки:
Ошибка:
Bad Form Datastate:
PROXY_REQ_FLOWerror.class:
com.apigee.rest.framework.BadRequestException- Значение ошибки
Bad Form Dataуказывает на то, что в параметрах формы есть недопустимые символы. - Значение состояния
PROXY_REQ_FLOW,указывает, что ошибка произошла в потоке запроса прокси-сервера API.
- Значение ошибки
- Найдите в трассировке этап AX (запись данных Аналитики) и нажмите на него.
Прокрутите страницу вниз до раздела Сведения об этапе – Заголовки ошибок и определите значения X-Apigee-fault-code, X-Apigee-fault-source и X-Apigee-fault-policy, как показано ниже:
Обратите внимание, что значения X-Apigee-fault-code и X-Apigee-fault-source соответственно равны
protocol.http.BadFormDataиpolicyи X-Apigee-fault-policy не является пустым. Это означает, что ошибка произошла, когда правило, указанное в заголовке X-Apigee-fault-policy, считывало или извлекало данные формы (параметры формы), в которых были недопустимые символы.Заголовки ответа Значение X-Apigee-fault-code protocol.http.BadFormDataX-Apigee-fault-source policyX-Apigee-fault-policy extractvariables/EV-ExtractFormParams- В этом примере X-Apigee-fault-policy – это
extractvariables/EV- ExtractFormParams,, что означает, что правило ExtractVariables с названиемEV-ExtractFormParamsне удалось выполнить при чтении или извлечении параметров формы.
nginx
Чтобы диагностировать ошибку с помощью журналов доступа NGINX:
- Если вы используете частное облако, то можете использовать журналы доступа NGINX, чтобы определить ключевую информацию об HTTP
500 Internal Server Error. Проверьте журналы доступа NGINX:
/opt/apigee/var/log/edge-router/nginx/ORG~ENV.PORT#_access_log- Выполните поиск, чтобы узнать, возникали ли ошибки
500с кодом ошибкиprotocol.http.BadFormDataза определенный период времени (если проблема возникла в прошлом) или есть ли запросы, которые по-прежнему завершаются с ошибкой500. Если вы обнаружите ошибки
500с кодом X-Apigee-fault-code, соответствующим значениюprotocol.http.BadFormData, определите значение X-Apigee-fault-source и X-Apigee-fault-policy.Пример ошибки 500 из журнала доступа NGINX:
В приведенной выше записи из журнала доступа NGINX для атрибутов X-Apigee-fault-code и X-Apigee-fault-source заданы следующие значения:
заголовки; Значение X-Apigee-fault-code protocol.http.BadFormDataX-Apigee-fault-source policyX-Apigee-fault-policy extractvariables/EV-ExtractFormParams- Обратите внимание, что значения X-Apigee-fault-code и X-Apigee-fault-source –
protocol.http.BadFormDataиpolicyсоответственно, а X-Apigee-fault-policy не пустое. Это означает, что ошибка произошла, когда правило, указанное в заголовке X-Apigee-fault-policy, считывало или извлекало данные формы (параметры формы), в которых были символы, запрещенные для использования. - В этом примере X-Apigee-fault-policy – это
extractvariables/EV- ExtractFormParams,, что означает, что правило ExtractVariables с названиемEV-ExtractFormParamsне удалось выполнить при чтении параметров формы.
Причина: параметры формы в запросе содержат недопустимые символы.
диагностика;
- Определите код ошибки, источник ошибки и правило ошибки для
500 Internal Server Error, используя мониторинг API, инструмент трассировки или журналы доступа NGINX, как описано в разделе Общие шаги диагностики. - Если Код ошибки –
protocol.http.BadFormData, Источник ошибки –proxyилиpolicy, а Правило ошибки не пустое, это означает, что правило, указанное в Правиле ошибки, не сработало при чтении или извлечении данных формы (параметров формы). - Ознакомьтесь с правилами, указанными в разделе Fault Policy (Правила в отношении нарушений), и определите:
- Источник. Определите, считывает ли правило или извлекает данные из запроса или ответа.
- Параметры формы. Определите, какие параметры формы считываются в правиле.
Пример 1
Пример 1. Правило ExtractVariables, извлекающее параметры формы:
<ExtractVariables name="EV-ExtractFormParms"> <DisplayName>EV-ExtractFormParams</DisplayName> <Source>request</Source> <FormParam name="username"> <Pattern ignoreCase="false">{username}</Pattern> </FormParam> <FormParam name="password"> <Pattern ignoreCase="false">{password}</Pattern> </FormParam> <VariablePrefix>forminfo</VariablePrefix> <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables> </ExtractVariables>В приведенном выше правиле ExtractVariables:
Источник:
requestЭто обозначается элементом
<Source>.Параметры формы:
usernameиpasswordЭто указывается с помощью элемента
<Pattern>в элементе<FormParam>.
Это означает, что параметры формы
usernameи/илиpassword, переданные в составе HTTP-запроса от клиента к Apigee Edge, содержат недопустимые символы.Пример 2
Пример 2. Правило AssignMessage, копирующее параметры формы:
<AssignMessage continueOnError="false" enabled="true" name="AM-CopyFormParams"> <Copy source="request"> <FormParams> <FormParam name="username"/> <FormParam name="password"/> </FormParams> </Copy> <AssignTo createNew="true" transport="http" type="request"/> </AssignMessage>
В приведенном выше правиле ExtractVariables:
Источник:
requestЭто можно определить по атрибуту
sourceв элементе<Copy>.Параметры формы:
usernameиpasswordЭто можно определить по атрибуту
nameв элементе<FormParam>.
Это означает, что параметры формы
usernameилиpasswordили оба параметра, переданные как часть HTTP-запроса от клиента к Apigee Edge, содержат символы, которые не разрешены для использования.
Проверьте, нет ли в параметрах формы, указанных на шаге 3, недопустимых символов. Это можно сделать одним из следующих способов:
Инструмент "Трассировка"
Чтобы выполнить проверку с помощью инструмента трассировки:
- Если вы записали трассировку для запроса, который не удалось выполнить, как описано в разделе Распространенные действия по диагностике, выберите один из таких запросов.
- Если вы определили, что параметры формы, содержащие символы, недопустимые для использования, являются частью HTTP-запроса на шаге 3 выше, то
- Перейдите к этапу Запрос получен от клиента.
Прокрутите страницу вниз до раздела Сведения об этапе и ознакомьтесь с запросом контента.
( посмотреть изображение в полном размере)
- В примере выше обратите внимание, что параметр формы
passwordсодержит знак процента (%). - Поскольку знак процента (
%) также используется для процентного кодирования специальных символов, его нельзя использовать в данных формы. - Поэтому Apigee Edge отвечает кодом ошибки
protocol.http.BadFormDataв объекте500 Internal Server Error.
Фактический запрос
Чтобы проверить запрос:
- Если у вас нет доступа к фактическому запросу, отправленному на целевой сервер, перейдите к разделу Решение проблемы.
- Если у вас есть доступ к фактическому запросу, отправленному в Apigee Edge, выполните следующие действия:
- Проверьте данные формы и убедитесь, что в них нет недопустимых символов, например знака процента (
%) или знака процента (%), за которым следуют недопустимые шестнадцатеричные символы.Пример 1
Пример запроса 1. Данные из формы в составе запроса
curl -X GET "https://HOSTALIAS/myproxy -H "Content-Type: application/x-www-form-urlencoded" -d "client_id=123456abc123&client_secret=c23578%ZY"
В этом примере элемент
client_secretсодержит знак процента (%), за которым следуют недопустимые шестнадцатеричные символыZY.Пример 2
Пример запроса 2. Данные формы передаются в файле:
curl -X GET "https://HOSTALIAS/myproxy -H "Content-Type: application/x-www-form-urlencoded" -d @form_data.xml
Содержимое файла form_data.xml:
xml=<user><username>abc1234@google.com</username><password>qwerty12345!@#$%</password></user>
В этом примере элемент
passwordсодержит знак процента (%), который не должен передаваться в данных формы как есть.
- Проверьте данные формы и убедитесь, что в них нет недопустимых символов, например знака процента (
- В приведенных выше примерах данные формы, отправленные в составе HTTP-запроса в Apigee Edge, содержат недопустимые символы.
- Поэтому Apigee Edge возвращает ответ
500 Internal Server Errorс кодом ошибкиprotocol.http.BadFormData.
Разрешение
- Убедитесь, что все специальные символы в ключах и значениях данных формы или параметров, отправляемых в составе HTTP-запроса клиента, всегда кодируются так, как описано в разделе Данные формы – application/x-www-form-urlencoded.
- В приведенных выше примерах проблемы можно устранить следующим образом:
Пример 1
Пример 1. Данные формы, переданные как часть запроса:
Используйте допустимые шестнадцатеричные символы, соответствующие коду ASCII для определенного символа. Например, если вы хотите отправить знак доллара (
$), используйте%24, как показано ниже:curl -X GET "https://HOSTALIAS/myproxy -H "Content-Type: application/x-www-form-urlencoded" -d "client_id=123456abc123&client_secret=c23578%24"
Пример 2
Пример запроса 2. Данные формы передаются в файле:
curl -X GET "https://HOSTALIAS/myproxy -H "Content-Type: application/x-www-form-urlencoded" -d @form_data.xml
Содержимое файла form_data.xml:
Используйте процентное кодирование для знака процента (
%), то есть измените файл так, чтобы в нем был символ%25, как показано ниже:xml=<user><username>abc1234@google.com</username><password>qwerty12345!!@#$%25</password></user>
Спецификация
Apigee Edge ожидает, что данные формы будут отправлены в соответствии со следующими спецификациями:
| Спецификация |
|---|
| Данные формы – application/x-www-form-urlencoded |
Если вам по-прежнему нужна помощь службы поддержки Apigee, перейдите к разделу Сбор диагностической информации.
Необходимо собрать диагностическую информацию
Если проблема не исчезнет после выполнения описанных выше инструкций, соберите указанную ниже диагностическую информацию и обратитесь в службу поддержки Apigee Edge.
Если вы пользователь общедоступного облака, предоставьте следующую информацию:
- Название организации
- Название среды
- Название прокси-сервера API
- Полная команда
curl, использованная для воспроизведения ошибки500 Internal Server Errorс кодомprotocol.http.BadFormData. - Файл трассировки для запросов к 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