Esta página se aplica a Apigee y Apigee Hybrid.
Consulta la documentación de
Apigee Edge.
En este tema, se describe la estructura de los errores de políticas y los tipos de variables de flujo que se establecen cuando se produce un error de políticas. Esta información es esencial si estás diseñando y, luego, implementando el control de errores para tus proxies.
En este tema, se supone que tienes un conocimiento general de cómo funciona el control de errores en Apigee y que sabes qué son las reglas de errores. Si necesitas una revisión, consulta Controla errores. La información que se muestra aquí también te ayudará a navegar y usar la Referencia de políticas de error.
Acerca de la respuesta de error de la política predeterminada
Cuando una política muestra un error, Apigee ingresa de inmediato el flujo de error y genera un mensaje de error. Este mensaje generado por el sistema es un objeto JSON que incluye dos bits de información: un errorcode y una faultstring.
Por ejemplo:
{
"fault":{
"detail":{
"errorcode":"steps.extractvariables.SourceMessageNotAvailable"
},
"faultstring":"mymessage message is not available for ExtractVariable: ParseJsonResponse"
}
}
Vamos a deconstruir rápidamente este mensaje de error:
El errorcode consta de un prefix y un error
name, de la siguiente manera: [prefix].[error_name]. En el ejemplo anterior, steps.extractvariables es el prefijo y SourceMessageNotAvailable es el nombre del error. El prefijo te indica qué tipo de política generó el error. En el ejemplo anterior, puedes saber que una política de ExtractVariables generó el error y el nombre del error es SourceMessageNotAvailable.
faultstring contiene una descripción del error. Por lo general, la string de error incluye pistas para ayudarte a encontrar el problema específico que causó el error, como el nombre de la política, el nombre de una variable sin resolver o lo que haya contribuido al error. Por ejemplo, en el mensaje de error anterior, mymessage es el nombre de una variable de mensaje sin resolver a la que se hace referencia en la política y ParseJsonResponse es el nombre de la política que activó el error.
Variables específicas para errores de la política
Cuando se activa un error de política, se propagan ciertas variables de flujo específicas del error. Estas variables son muy útiles en el manejo de errores. Como se explica en Controla errores, es una práctica común capturar los errores de políticas generados por el sistema y realizar una acción posterior, como crear una respuesta de error personalizada. Por ejemplo, por motivos de seguridad, es posible que desees evitar que los clientes vean los errores y los códigos de estado reales que muestra Apigee.
La variable fault.name
Cuando una política muestra un error, establece la variable de flujo fault.name como la parte error_name del código de error (como se describió en la sección anterior). Es muy común evaluar esta variable para ejecutar reglas de errores de forma condicional.
Esta es una regla de error de ejemplo que prueba el valor de fault.name:
<faultrule name="VariableOfNonMsgType"></faultrule><FaultRule name="Source Message Not Available Fault">
<Step>
<Name>AM-CustomErrorMessage</Name>
<Condition>(fault.name Matches "SourceMessageNotAvailable") </Condition>
</Step>
</FaultRule>
Lo que debes recordar es que cuando una política activa un error, la variable fault.name siempre se configura como el nombre del error.
La variable [prefix].[policy_name].failed
Además de fault.name, otra variable que los desarrolladores suelen verificar es la marca [prefix].[policy_name].failed, que se establece como verdadera o falsa cuando se ejecuta una política. En las reglas de errores, se recomienda verificar cuándo es verdadera, es decir, verificar si se produjo un error. A continuación, se explica cómo construir una condicional que verifique la marca [prefix].[policy_name].failed. Para verificar esta variable de forma correcta, debes saber dos cosas:
- El nombre de la política que estás verificando. Este es el valor del atributo de nombre de la política, no el nombre visible. Este atributo siempre se incluye en el XML de la definición de la política.
- Un prefijo que es específico del tipo de política que verificas. (Explicaremos cómo encontrar el prefijo a continuación).
A modo de ejemplo, este es otro ejemplo de regla de error. Observa en la condición externa cómo se forma el nombre de la variable [prefix].[policy_name].failed. En este caso, el prefijo es extractvariables y el nombre de la política es ParseJsonResponse. En este caso, la regla de error solo se ejecutará si esta variable es verdadera. Esta es una sugerencia: dado que las reglas de errores pueden contener varios pasos, este patrón es una buena manera de organizarlas en bloques.
<faultrule name="VariableOfNonMsgType"></faultrule><FaultRule name="Extract Variable Faults">
<Step>
<Name>AM-CustomErrorMessage</Name>
<Condition>(fault.name Matches "SourceMessageNotAvailable") </Condition>
</Step>
<Condition>(extractvariables.ParseJsonResponse.failed = true) </Condition>
</FaultRule>
Acerca de las variables error y message
La variable error solo está disponible en el flujo de error de un proxy. Puedes obtener información útil de la variable error, como el mensaje de error, el código de estado, la frase de motivo, etcétera. El patrón de formato para la variable de error es el siguiente:
error.ERROR_COMPONENT = VALUE
Por ejemplo:
error.message = "request message is not available for ExtractVariable: ParseJsonResponse"
y
error.status.code = "500"
La variable message también está disponible en el flujo de error y se puede usar para propósitos similares a los de la variable error. La variable de mensaje es especial porque es contextual. En un flujo de solicitudes, se comporta como una variable de solicitud y, en un flujo de respuesta, se puede usar para obtener o establecer valores de respuesta.
Consulta la Referencia de variables de flujo para obtener información sobre todas las variables de Apigee, incluidas error y message.