Política de PythonScript

Esta página se aplica a Apigee y Apigee Hybrid.

Consulta la documentación de Apigee Edge.

Qué

La política de secuencias de comandos de Python te permite añadir funciones de Python personalizadas al flujo de tu proxy de API, sobre todo cuando las funciones que necesitas van más allá de lo que ofrecen las políticas listas para usar de Apigee.

Esta política es una política extensible y su uso puede tener implicaciones en cuanto a costes o utilización, en función de tu licencia de Apigee. Para obtener información sobre los tipos de políticas y las implicaciones de uso, consulta Tipos de políticas.

La compatibilidad con el lenguaje Python se proporciona a través de Jython versión 2.5.2. Las bibliotecas de terceros que añadas deben ser "Python puro" (implementadas solo en Python). Para obtener más información sobre cómo añadir bibliotecas, consulta Archivos de recursos.

Nota: Es posible que esta función no esté disponible en todos los planes de Apigee. Para ver qué plan de precios incluye esta función, consulta https://cloud.google.com/apigee/pricing/.

Una política de Python no contiene código. En su lugar, una política de Python hace referencia a un recurso de Python y define el paso del flujo de la API en el que se ejecuta la secuencia de comandos de Python. Puede subir su secuencia de comandos a través del editor de proxies de la interfaz de Apigee o incluirla en el directorio /resources/py de los proxies de API que desarrolle de forma local.

ADVERTENCIA:
Debes limitar o inhabilitar el acceso SSH a tus recursos de seguridad para evitar que esta política se utilice para acceder a archivos internos, información del usuario actual, la lista de procesos o la utilización de la CPU o la memoria.

Ejemplos

Política y secuencia de comandos de Python

Política de secuencias de comandos de Python

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Script name="Python-1">
        <DisplayName>Python-1</DisplayName>
        <ResourceURL>py://myscript.py</ResourceURL>
</Script>

En este ejemplo, el elemento ResourceURL especifica el recurso de la secuencia de comandos de Python pertinente.

Script de Python

Esto muestra lo que puedes incluir en la propia secuencia de comandos de Python.

import base64

username = flow.getVariable("request.formparam.client_id")
password = flow.getVariable("request.formparam.client_secret")

base64string = base64.encodestring('%s:%s' % (username, password))[:-1]
authorization = "Basic "+base64string

flow.setVariable("authorizationParam",authorization)

Referencia de elemento

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Script name="Python-1">
    <DisplayName>Python-1</DisplayName>
    <ResourceURL>py://myscript.py</ResourceURL>
    <IncludeURL>py://myscript_dependency.py</IncludeURL>
</Script>

En la siguiente tabla se describen los atributos que son comunes a todos los elementos superiores de la política:

Atributo	Descripción	Predeterminado	Presencia
name	El nombre interno de la política. El valor del atributo name puede contener letras, números, espacios, guiones, guiones bajos y puntos. Este valor no puede superar los 255 caracteres. Opcionalmente, usa el elemento <DisplayName> para etiquetar la política en el editor de proxy de la interfaz de gestión con un nombre diferente en lenguaje natural.	N/A	Obligatorio
continueOnError	Asigna el valor false para devolver un error cuando falle una política. Este es el comportamiento esperado de la mayoría de las políticas. Asigna el valor true para que la ejecución del flujo continúe incluso después de que falle una política. Consulta también: Las reglas de errores solo se activan cuando hay un error (sobre continueOnError) Gestionar fallos en el flujo actual	falso	Opcional
enabled	Asigna el valor true para aplicar la política. Selecciona false para desactivar la política. La política no se aplicará aunque siga adjunta a un flujo.	true	Opcional
async	Este atributo está obsoleto.	falso	Obsoleto

Elemento <DisplayName>

Úsalo junto con el atributo name para etiquetar la política en el editor de proxy de la interfaz de gestión con un nombre diferente en lenguaje natural.

<DisplayName>Policy Display Name</DisplayName>

Predeterminado	N/A Si omite este elemento, se usará el valor del atributo name de la política.
Presencia	Opcional
Tipo	Cadena

Elemento<ResourceURL>

Este elemento especifica el archivo principal de Python que se ejecutará en el flujo de la API. Puedes almacenar este archivo en el ámbito del proxy de API (en /apiproxy/resources/py del paquete del proxy de API o en la sección Scripts del panel de navegación del editor del proxy de API) o en los ámbitos de la organización o del entorno para reutilizarlo en varios proxies de API, tal como se describe en Archivos de recursos. Tu código puede usar los objetos, métodos y propiedades del modelo de objetos de JavaScript.

<ResourceURL>py://myscript.py</ResourceURL>

Valor predeterminado:	Ninguno
Presencia:	Obligatorio
Tipo:	Cadena

Elemento <IncludeURL>

Especifica un archivo de Python que se cargará como dependencia del archivo de Python principal especificado con el elemento <ResourceURL>. Las secuencias de comandos se evaluarán en el orden en el que aparezcan en la política.

Incluye más de un recurso de dependencia de Python con elementos <IncludeURL> adicionales.

Advertencia: Si tus archivos de Python están almacenados en el proxy o en el entorno, asegúrate de que se hayan subido correctamente con cURL mediante la opción -F o como archivo adjunto a través de un cliente REST. Content-Type es multipart/form-data. Para obtener más información, consulta Archivos de recursos.

<IncludeURL>py://myscript_dependency.py</IncludeURL>

Valor predeterminado:	Ninguno
Presencia:	Opcional
Tipo:	Cadena

Códigos de error

En esta sección se describen los códigos de error y los mensajes de error que se devuelven, así como las variables de error que define Apigee cuando esta política activa un error. Es importante que conozcas esta información si vas a desarrollar reglas de errores para gestionar los errores. Para obtener más información, consulta Qué debes saber sobre los errores de políticas y Cómo gestionar los fallos.

Errores de tiempo de ejecución

Estos errores pueden producirse cuando se ejecuta la política.

Nota: ¿Necesitas ayuda para resolver un error? En la columna Solucionar, haz clic en para obtener información detallada sobre cómo solucionar el problema.

Código de fallo	Estado de HTTP	Causa	Solucionar
steps.script.ScriptEvaluationFailed	500	La política PythonScript puede generar varios tipos de errores ScriptExecutionFailed. Entre los tipos de errores que se suelen ver se incluyen NameError y ZeroDivisionError.

Errores de implementación

Estos errores pueden producirse al implementar un proxy que contenga esta política.

Nota: ¿Necesitas ayuda para resolver un error? Haz clic en junto a la descripción de la causa del error para ir a la página de solución de problemas.

Nombre del error	Causa	Solucionar
InvalidResourceUrlFormat	Si el formato de la URL del recurso especificado en el elemento <ResourceURL> o en el <IncludeURL> de la política PythonScript no es válido, se producirá un error al implementar el proxy de API.
InvalidResourceUrlReference	Si los elementos <ResourceURL> o <IncludeURL> hacen referencia a un archivo PythonScript que no existe, se producirá un error al implementar el proxy de API. El archivo de origen al que se hace referencia debe estar en el proxy de la API, en el entorno o en la organización.

Variables de error

Estas variables se definen cuando esta política activa un error en el tiempo de ejecución. Para obtener más información, consulta Qué debes saber sobre los errores de las políticas.

Variables	Dónde	Ejemplo
fault.name="fault_name"	fault_name es el nombre del fallo, tal como se indica en la tabla Errores de tiempo de ejecución de arriba. El nombre del error es la última parte del código de error.	fault.name Matches "ScriptExecutionFailed"
pythonscript.policy_name.failed	policy_name es el nombre de la política especificado por el usuario que ha provocado el error.	pythonscript.PythonScript-1.failed = true

Ejemplo de respuesta de error

Nota: Para gestionar los errores, la práctica recomendada es interceptar la parte errorcode de la respuesta de error. No te fíes del texto de la faultstring, ya que podría cambiar.

{
  "fault": {
    "faultstring": "Execution of SetResponse failed with error: Pythonscript runtime error: "ReferenceError: "status" is not defined.\"",
    "detail": {
      "errorcode": "steps.script.ScriptExecutionFailed"
    }
  }
}

Regla de fallo de ejemplo

<FaultRule name="PythonScript Policy Faults">
    <Step>
        <Name>AM-CustomErrorResponse</Name>
        <Condition>(fault.name Matches "ScriptExecutionFailed") </Condition>
    </Step>
    <Condition>(pythonscript.PythonScript-1.failed = true) </Condition>
</FaultRule>