Error interno del servidor - BadPath

Estás viendo la documentación de Apigee Edge.
Ir a la documentación de Apigee X. info

Síntoma

La aplicación cliente obtiene un código de estado HTTP 500 Internal Server Error con el código de error protocol.http.BadPath como respuesta a las llamadas a la API.

Mensaje de error

La aplicación cliente obtiene el siguiente código de respuesta:

HTTP/1.1 500 Internal Server Error

Además, es posible que observes el siguiente mensaje de error:

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

Causas posibles

Este error se produce si la URL de la solicitud del servidor de backend, representada por la variable de flujo target.url, contiene un path que comienza con un signo de interrogación (?) en lugar de una barra diagonal (/), que no es válida.

Según las especificaciones RFC 3986, sección 3: Componentes de sintaxis y RFC 3986, sección 3.3: Ruta de acceso:

1. La sintaxis del URI tiene los siguientes componentes:

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

2. El componente path es obligatorio y DEBE comenzar con una barra diagonal (/) y tenerla siempre.

Por lo tanto, si la URL de la solicitud del servidor de backend tiene un componente path que comienza con un signo de interrogación (?) en lugar de una barra diagonal (/), Apigee Edge responde con 500 Internal Server Error y el código de error protocol.http.BadPath.

Por ejemplo, si target.url tiene el valor https://www.mocktarget.apigee.net?json, se produce este error, ya que se detecta que path es inválido, ya que comienza con un signo de interrogación (?) en lugar de una barra diagonal (/).

Pasos comunes de diagnóstico

Usa una de las siguientes herramientas o técnicas para diagnosticar este error:

Causa: La URL del servidor de backend (target.url) tiene una ruta de acceso no válida

Diagnóstico

1. Determina el código de error y la fuente del error para 500 Internal Server Error con la supervisión de API, la herramienta Trace o los registros de acceso de NGINX, como se explica en los pasos de diagnóstico comunes.
2. Si el Código de error es protocol.http.BadPath y la Fuente del error tiene el valor target, esto indica que la URL del servidor de backend tiene una ruta de acceso no válida.

3. La URL del servidor de backend se representa con la variable de flujo target.url en Apigee Edge. Por lo general, este error se produce si intentas actualizar la URL del servidor de backend (target.url) de forma dinámica con cualquiera de las políticas (dentro del flujo compartido o del proxy) en el flujo de solicitud de destino, de modo que tenga una ruta de acceso no válida.

4. Determina si la variable de flujo target.url realmente tiene una ruta no válida y la fuente de su valor con uno de los siguientes métodos:

   Seguimiento

   Cómo usar la herramienta de Trace

   Si capturaste un registro para este error, sigue los pasos que se explican en Cómo usar la herramienta Trace y

   1. Verifica si target.url tiene una ruta de acceso no válida, es decir, si comienza con un signo de interrogación (?) en lugar de una barra diagonal (/).

   2. Si es así, busca la política que modificó o actualizó el valor de target.url para que contenga una ruta de acceso no válida.

      Muestra de registro que muestra que la política de JavaScript actualizó la variable de flujo target.url

      
   3. En el registro de muestra anterior, observa que la política de JavaScript modificó o actualizó el valor de target.url para que contenga una ruta de acceso no válida.
   4. Ten en cuenta que target.url tiene los siguientes componentes:
      • scheme: https
      • authority: mocktarget.apigee.net
      • ruta: ?json

      La ruta de acceso comienza con un signo de interrogación (?) en lugar de una barra diagonal (/), por lo que no es válida.

   Registros

   Usa registros en tu servidor de registros

   1. Si no tienes un registro de este error (un problema intermitente), verifica si registraste la información sobre el valor de la variable de flujo target.url con políticas como MessageLogging o ServiceCallout en tu servidor de registro.
   2. Si tienes los registros, revísalos y
      1. Verifica si target.url tiene una ruta de acceso no válida.
      2. Determina si puedes obtener información sobre qué política modificó target.url para que contenga una ruta de acceso no válida.

   proxy de API

   Revisa el proxy de API que falló

   Si no tienes un registro o un seguimiento de este error, revisa el proxy de API con errores para determinar qué modificó o actualizó la variable de flujo target.url para que contenga una ruta no válida. Verifica lo siguiente:

   • La política dentro del proxy de API
   • Cualquier flujo compartido invocado desde el proxy

5. Examina detenidamente la política específica (por ejemplo, AssignMessage o JavaScript) que modifica o actualiza la variable de flujo target.url y determina la causa de la actualización de target.url para que tenga una ruta no válida.

   A continuación, se incluyen algunos ejemplos de políticas que actualizan la variable de flujo target.url de forma incorrecta para que contenga una ruta no válida que genera este error.

   Ejemplo 1

   Muestra 1: Actualización de la variable target.url de la política de JavaScript

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

   En la muestra anterior, ten en cuenta que la variable de flujo target.url se actualiza con el valor https://mocktarget.apigee.net?json que contiene otra variable url..

   Ten en cuenta que el valor de url tiene los siguientes componentes:

   • scheme: https
   • authority: mocktarget.apigee.net
   • ruta: ?json

   La ruta de acceso comienza con un signo de interrogación (?) en lugar de una barra diagonal (/), lo que no es válido. Por lo tanto, Apigee Edge devuelve 500 Internal Server Error con el código de error protocol.http.BadPath.

   Muestra 2

   Ejemplo 2: Política de JavaScript que actualiza la variable target.url según el valor del encabezado de la solicitud

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

   En la muestra anterior, observa que la variable de flujo target.url se actualiza concatenando el valor https://mocktarget.apigee.net contenido en una variable url y el valor de otra variable path, cuyo valor se recupera de request.header.Path..

   Si tienes acceso a la solicitud o al registro reales, puedes verificar el valor real que se pasó a request.header.Path.

   Solicitud de muestra realizada por el usuario

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

   En este ejemplo, la ruta de acceso del encabezado no se envía como parte de la solicitud. Por lo tanto, el valor de la variable path en la política de JavaScript es null.

   Entonces:

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

   Ten en cuenta que el valor de target.url tiene los siguientes componentes:

   • scheme: https
   • authority: mocktarget.apigee.net
   • ruta: ?user

   La ruta de acceso comienza con un signo de interrogación (?) en lugar de una barra diagonal (/), lo que no es válido. Por lo tanto, Apigee Edge devuelve 500 Internal Server Error con el código de error protocol.http.BadPath.

   Muestra 3

   Ejemplo 3: Actualización de la variable target.url de la política AssignMessage

   <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>

   Ten en cuenta que el valor de url tiene los siguientes componentes:

   • scheme: https
   • authority: mocktarget.apigee.net
   • ruta: ?echo

   En este ejemplo, la ruta de acceso comienza con un signo de interrogación (?) en lugar de una barra diagonal (/), lo que no es válido. Por lo tanto, Apigee Edge devuelve 500 Internal Server Error con el código de error protocol.http.BadPath.

Solución

Según la especificación de URL RFC 3986, sección 3: Componentes de sintaxis, el componente path es obligatorio y SIEMPRE debe comenzar con "/". Por lo tanto, sigue los pasos que se indican a continuación para solucionar este problema:

1. Asegúrate de que la URL del servidor de backend, representada por la variable de flujo target.url, siempre tenga una ruta de acceso válida y siempre comience con una barra diagonal (/).
   1. En algunos casos, es posible que no tengas un nombre de recurso en la ruta. En ese caso, asegúrate de que la ruta tenga, al menos, una barra diagonal (/).
   2. Si usas otras variables para determinar el valor de la variable de flujo target.url, asegúrate de que esas otras variables no tengan una ruta de acceso no válida.
   3. Si realizas alguna operación de cadena para determinar el valor de la variable de flujo target.url, asegúrate de que el resultado o el desenlace de las operaciones de cadena no tengan una ruta no válida.

2. En las muestras analizadas anteriormente, puedes solucionar este problema de la siguiente manera:

   Ejemplo 1

   Muestra 1: Actualización de la variable target.url de la política de JavaScript

   Usa una barra diagonal (/) en lugar de un signo de interrogación (?) en la variable url para solucionar este problema, como se muestra a continuación:

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

   Muestra 2

   Ejemplo 2: Política de JavaScript que actualiza la variable target.url según el valor del encabezado de la solicitud

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

   Asegúrate de pasar una ruta de acceso válida, por ejemplo, /user como parte del encabezado de solicitud Path para solucionar este problema, como se muestra a continuación:

   Solicitud de ejemplo:

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

   Muestra 3

   Ejemplo 3: Política AssignMessage que actualiza la variable target.url

   Agrega una ruta de acceso válida en el elemento <Value> de la política AssignMessage. Es decir, reemplaza el signo de interrogación (?) por una barra diagonal (/) en el elemento <Value> y configúralo como https://mocktarget.apigee.net/echo para solucionar este problema, como se muestra a continuación:

   <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>

   Especificación

   Apigee Edge espera que el path componente en la URL del servidor de backend SIEMPRE debe comenzar con una barra (/) según las siguientes especificaciones:

   Especificación
   RFC 3986, sección 3: Componentes de sintaxis
   RFC 3986, sección 3.3: Ruta de acceso

   Si aún necesitas ayuda del equipo de asistencia de Apigee, consulta Recopila información de diagnóstico.

   Se debe recopilar información de diagnóstico

   Si el problema persiste incluso después de seguir las instrucciones anteriores, recopila la siguiente información de diagnóstico y, luego, comunícate con Asistencia de Apigee Edge:

   Si eres usuario de la nube pública, proporciona la siguiente información:

   • Nombre de la organización
   • Nombre del entorno
   • Nombre del proxy de API
   • Comando curl completo que se usa para reproducir el 500 Internal Server Error con el código de error protocol.http.BadPath
   • Archivo de registro de las solicitudes a la API

   Si eres usuario de la nube privada, proporciona la siguiente información:

   • Mensaje de error completo observado para las solicitudes con errores
   • Nombre del entorno
   • Paquete de proxy de API
   • Archivo de registro de las solicitudes a la API

   • Registros de acceso de NGINX:

     /opt/apigee/var/log/edge-router/nginx/ORG~ENV.PORT#_access_log

     Dónde: ORG, ENV y PORT# se reemplazan por valores reales.

   • Registros del sistema de Message Processor /opt/apigee/var/log/edge-message- processor/logs/system.log

   Referencias

   Variables de flujo: objetivo