500 Внутренняя ошибка сервера — BadPath

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

Симптом

В ответ на вызовы API клиентское приложение получает HTTP-статус 500 Internal Server Error с кодом ошибки protocol.http.BadPath .

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

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

HTTP/1.1 500 Internal Server Error

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

{
   "fault":{
      "faultstring":"Invalid request path",
      "detail":{
         "errorcode":"protocol.http.BadPath"
      }
   }
}

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

Эта ошибка возникает, если URL-адрес запроса к бэкэнд-серверу, представленный переменной потока target.url , содержит path Если символ начинается с вопросительного знака ( ? ) вместо косой черты ( / ), это недопустимо .

В соответствии со спецификациями RFC 3986, раздел 3: Компоненты синтаксиса и RFC 3986, раздел 3.3: Путь :

1. Синтаксис URI включает следующие компоненты:

           foo://example.com:8042/over/there?name=ferret#nose
           \_/   \______________/\_________/ \_________/ \__/
            |            |            |            |       |
         scheme      authority       path        query   fragment
   

2. Компонент path обязателен и ОБЯЗАТЕЛЬНО должен начинаться с косой черты ( / ).

Следовательно, если URL-адрес запроса к бэкэнд-серверу содержит компонент path , начинающийся с вопросительного знака ( ? ) вместо косой черты ( / ), то Apigee Edge отвечает ошибкой 500 Internal Server Error и кодом ошибки protocol.http.BadPath .

Например: если target.url имеет значение https://www.mocktarget.apigee.net?json , то возникает эта ошибка, поскольку path оказывается недействительным, так как начинается с вопросительного знака ( ? ) вместо косой черты ( / ).

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

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

Причина: URL-адрес бэкэнд-сервера (target.url) содержит недопустимый путь.

Диагноз

1. Определите код ошибки и источник ошибки 500 Internal Server Error используя мониторинг API, инструмент трассировки или журналы доступа NGINX, как описано в разделе «Общие шаги диагностики» .
2. Если код ошибки равен protocol.http.BadPath , а источник ошибки имеет значение target , это указывает на то, что URL-адрес бэкэнд-сервера содержит недопустимый путь .

3. URL-адрес бэкэнд-сервера представлен переменной потока target.url в Apigee Edge. Эта ошибка обычно возникает, если вы пытаетесь динамически обновить URL-адрес бэкэнд-сервера ( target.url ) с помощью любой из политик (в рамках прокси/общего потока) в потоке запроса Target, в результате чего путь оказывается недопустимым .

4. Определите, действительно ли переменная потока target.url содержит недопустимый путь и источник своего значения, используя один из следующих методов:

   След

   Использование инструмента трассировки

   Если вы получили трассировку этой ошибки, выполните действия, описанные в разделе «Использование инструмента трассировки ».

   1. Проверьте, не содержит ли target.url недопустимый путь, то есть начинается ли он с вопросительного знака ( ? ) вместо косой черты ( / ).

   2. Если да, то выясните, какая политика изменила или обновила значение target.url , добавив в него недопустимый путь.

      Пример трассировки, демонстрирующий обновление переменной потока target.url политикой JavaScript.

      
   3. В приведенном выше примере трассировки обратите внимание, что политика JavaScript изменила или обновила значение target.url , добавив в него недопустимый путь.
   4. Обратите внимание, что target.url состоит из следующих компонентов:
      • схема: https
      • авторитетный источник: mocktarget.apigee.net
      • путь: ?json

      Путь начинается с вопросительного знака ( ? ) вместо косой черты ( / ) , поэтому он недействителен.

   Журналы

   Использование журналов на вашем сервере журналов

   1. Если у вас нет трассировки для этой ошибки (проблема возникает периодически), проверьте, зарегистрирована ли информация о значении переменной потока target.url с помощью таких политик, как MessageLogging или ServiceCallout , на вашем сервере журналов.
   2. Если у вас есть журналы событий, просмотрите их и
      1. Проверьте, не содержит ли target.url недопустимый путь, и
      2. Попробуйте определить, какая политика изменила target.url , добавив в него недопустимый путь.

   API-прокси

   Проверка неисправного API-прокси

   Если у вас нет трассировки или журналов этой ошибки, просмотрите неисправный API-прокси, чтобы определить, что изменило или обновило переменную потока target.url , добавив в нее недопустимый путь. Проверьте следующее:

   • Политика в рамках API-прокси
   • Любые общие потоки, вызываемые из прокси-сервера.

5. Внимательно изучите конкретную политику (например, AssignMessage или JavaScript), которая изменяет или обновляет переменную потока target.url , и определите причину обновления target.url до недопустимого пути.

   Вот несколько примеров политик, которые некорректно обновляют переменную потока target.url , добавляя в нее недопустимый путь, что приводит к этой ошибке.

   Образец №1

   Пример №1: Обновление переменной target.url в соответствии с политикой JavaScript

   var url = "https://mocktarget.apigee.net?json"
   context.setVariable("target.url", url);

   В приведенном выше примере обратите внимание, что переменная потока target.url обновляется значением https://mocktarget.apigee.net?json содержащимся в другой переменной url .

   Обратите внимание, что значение url состоит из следующих компонентов:

   • схема: https
   • авторитетный источник: mocktarget.apigee.net
   • путь: ?json

   Путь начинается с вопросительного знака ( ? ) вместо косой черты ( / ) , что недопустимо . Поэтому Apigee Edge возвращает 500 Internal Server Error с кодом ошибки protocol.http.BadPath .

   Образец №2

   Пример №2: Политика JavaScript обновляет переменную target.url на основе значения в заголовке запроса.

   var path = context.getVariable("request.header.Path");
   var url = "https://mocktarget.apigee.net" + path
   context.setVariable("target.url", url);

   В приведенном выше примере обратите внимание, что переменная потока target.url обновляется путем конкатенации значения https://mocktarget.apigee.net содержащегося в переменной url и значение другой переменной path , значение которой извлекается из request.header.Path .

   Если у вас есть доступ к самому запросу или трассировке, вы можете проверить фактическое значение, переданное в request.header.Path .

   Пример запроса, сделанного пользователем.

   curl -v https://HOST_ALIAS/v1/myproxy -H "Authorization: Bearer <token> -H "Path: ?user"
   

   В этом примере заголовок path не отправляется в составе запроса. Поэтому значение переменной path в политике JavaScript равно null .

   Так:

   • url = https://mocktarget.apigee.net + path
   • url = https://mocktarget.apigee.net + "?user"
   • target.url = https://mocktarget.apigee.net?user

   Обратите внимание, что значение target.url состоит из следующих компонентов:

   • схема: https
   • авторитетный источник: mocktarget.apigee.net
   • путь: ?user

   Путь начинается с вопросительного знака ( ? ) вместо косой черты ( / ) , что недопустимо . Поэтому Apigee Edge возвращает 500 Internal Server Error с кодом ошибки protocol.http.BadPath .

   Образец №3

   Пример №3: Политика AssignMessage обновляет переменную target.url

   <AssignMessage async="false" continueOnError="false" enabled="true" name="AM-SetTargetURL">
       <DisplayName>AM-SetTargetURL</DisplayName>
       <AssignVariable>
            <Name>target.url</Name>
            <Value>https://mocktarget.apigee.net?echo</Value>
       </AssignVariable>
       <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
       <AssignTo createNew="false" transport="http" type="request"/>
   </AssignMessage>

   Обратите внимание, что значение параметра url состоит из следующих компонентов:

   • схема: https
   • авторитетный источник: mocktarget.apigee.net
   • путь: ?echo

   В этом примере путь начинается с вопросительного знака ( ? ) вместо косой черты ( / ) , что недопустимо . Поэтому Apigee Edge возвращает 500 Internal Server Error с кодом ошибки protocol.http.BadPath .

Разрешение

Согласно спецификации URL RFC 3986, раздел 3: Компоненты синтаксиса , компонент path является обязательным и ДОЛЖЕН всегда начинаться с "/" . Поэтому выполните следующие шаги, чтобы исправить эту проблему:

1. Убедитесь, что URL-адрес бэкэнд-сервера, представленный переменной потока target.url , всегда имеет допустимый путь и всегда начинается с косой черты ( / ) .
   1. В некоторых случаях в пути может отсутствовать имя ресурса, в этом случае убедитесь, что путь содержит хотя бы косую черту ( / ).
   2. Если вы используете какие-либо другие переменные для определения значения переменной потока target.url , убедитесь, что другие переменные не содержат недопустимого пути .
   3. Если вы выполняете какие-либо строковые операции для определения значения переменной потока target.url , убедитесь, что результат этих строковых операций не содержит недопустимого пути .

2. В приведенных выше примерах эту проблему можно исправить следующим образом:

   Образец №1

   Пример №1: Обновление переменной target.url в соответствии с политикой JavaScript

   Для исправления этой проблемы используйте косую черту ( / ) вместо вопросительного знака ( ? ) в переменной url , как показано ниже:

   var url = "https://mocktarget.apigee.net/json"
   context.setVariable("target.url", url);

   Образец №2

   Пример №2: Политика JavaScript обновляет переменную target.url на основе значения в заголовке запроса.

   var path = context.getVariable("request.header.Path");
   var url = "https://mocktarget.apigee.net" + path
   context.setVariable("target.url", url);

   Убедитесь, что вы передаете допустимый путь, например: /user в заголовке запроса Path , чтобы исправить эту проблему, как показано ниже:

   Пример запроса:

   curl -v https://HOST_ALIAS/v1/myproxy -H "Authorization: Bearer <token> -H "Path: /user"
   

   Образец №3

   Пример №3: Политика AssignMessage обновляет переменную target.url

   Добавьте допустимый путь в элемент <Value> политики AssignMessage. То есть замените вопросительный знак ( ? ). с косая черта ( / ) Чтобы исправить эту проблему, установите значение в элементе <Value> на https://mocktarget.apigee.net/echo , как показано ниже:

   <AssignMessage async="false" continueOnError="false" enabled="true" name="AM-SetTargetURL">
       <DisplayName>AM-SetTargetURL</DisplayName>
       <AssignVariable>
            <Name>target.url</Name>
            <Value>https://mocktarget.apigee.net/echo</Value>
       </AssignVariable>
       <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
       <AssignTo createNew="false" transport="http" type="request"/>
   </AssignMessage>

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

   Компания Apigee Edge ожидает, что path компонент В URL-адресе бэкэнд-сервера ВСЕГДА должен начинаться с символа . косая черта ( / ) в соответствии со следующими техническими условиями:

   Спецификация
   RFC 3986, раздел 3: Компоненты синтаксиса
   RFC 3986, раздел 3.3: Путь

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

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

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

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

   • Название организации
   • Название среды
   • Имя API-прокси
   • Полная команда curl , использованная для воспроизведения 500 Internal Server Error с кодом ошибки protocol.http.BadPath
   • Файл трассировки для запросов 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

   Ссылки

   Переменные потока - целевые значения