Política PythonScript

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

Consulta la documentación de Apigee Edge.

Qué

La política de secuencia de comandos de Python te permite agregar funciones personalizadas de Python a tu flujo de proxy de API, en particular, cuando las funciones que necesitas no son proporcionadas por las políticas listas para usar de Apigee.

Esta política es una política extensible, y el uso de esta política puede tener implicaciones de costo o uso, según tu licencia de Apigee. Para obtener información sobre los tipos de políticas y sus implicaciones de uso, consulta Tipos de políticas.

La compatibilidad con el lenguaje Python se proporciona a través de la versión 2.5.2 de Jython. Las bibliotecas de terceros que agregues deben ser “Python puro” (solo implementado en Python). Para obtener más información sobre cómo agregar bibliotecas, consulta Archivos de recursos.

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

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

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

Ejemplos

Política y secuencia de comandos de Python

Política de secuencia 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 secuencia de comandos de Python correspondiente.

Secuencia de comandos de Python

Aquí se muestra lo que podrías incluir en la 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 elementos

<?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 principales de las políticas:

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. De forma opcional, usa el elemento <DisplayName> para etiquetar la política en el editor de proxy de la IU de administración con un nombre de lenguaje natural diferente.	N/A	Obligatorio
continueOnError	Configúralo como false para mostrar un error cuando una política falla. Este es el comportamiento previsto para la mayoría de las políticas. Configúralo como true para continuar con la ejecución del flujo incluso después de que una política falle. También consulta lo siguiente: Las reglas de fallas se activan SOLAMENTE en un estado de error (sobre el continueOnError) Controla fallas dentro del flujo actual	falso	Opcional
enabled	Configúralo como true para aplicar la política. Configúralo como false para desactivar la política. La política no se aplicará incluso si permanece adjunta a un flujo.	true	Opcional
async	Este atributo dejó de estar disponible.	falso	Obsoleta

Elemento <DisplayName>

Se usan además del atributo name para etiquetar la política en el editor de proxy de la IU de administración con un nombre de lenguaje natural diferente.

<DisplayName>Policy Display Name</DisplayName>

Predeterminada	N/A Si omites este elemento, se usa el valor del atributo name de la política.
Presencia	Opcional
Tipo	String

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 permiso del proxy de API (en /apiproxy/resources/py en el paquete del proxy de API o en la sección de secuencias de comandos del panel de navegación del editor de proxy de API), o en los permisos de la organización o del entorno para volver a utilizarse en múltiples proxies de API, como se describe en Archivos de recursos. Tu código puede usar los objetos, los métodos y las propiedades del modelo de objetos de JavaScript.

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

Predeterminado:	None
Presencia:	Obligatorio
Tipo:	String

Elemento <IncludeURL>

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

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

Advertencia: Si tus archivos de Python se almacenan a nivel de la organización o del entorno, asegúrate de que se hayan subido de forma correcta con cURL mediante la opción -F o como un archivo adjunto a través de un cliente REST. El tipo de contenido es multipart/form-data. Para obtener más información, consulta Archivos de recursos.

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

Predeterminado:	None
Presencia:	Opcional
Tipo:	String

Códigos de error

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Tip: Need help resolving an error? Click in the Fix column for detailed troubleshooting information.

Fault code	HTTP status	Cause	Fix
steps.script.ScriptEvaluationFailed	500	The PythonScript policy can throw several different types of ScriptExecutionFailed errors. Commonly seen types of errors include NameError and ZeroDivisionError.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Tip: Need help resolving an error? Click next to the error's cause description to visit the troubleshooting page.

Error name	Cause	Fix
InvalidResourceUrlFormat	If the format of the resource URL specified within the <ResourceURL> or the <IncludeURL> element of the PythonScript policy is invalid, then the deployment of the API proxy fails.
InvalidResourceUrlReference	If the <ResourceURL> or the <IncludeURL> elements refer to a PythonScript file that does not exist, then the deployment of the API proxy fails. The referenced source file must exist either the API proxy, environment, or organization level.

Fault variables

These variables are set when this policy triggers an error at runtime. For more information, see What you need to know about policy errors.

Variables	Where	Example
fault.name="fault_name"	fault_name is the name of the fault, as listed in the Runtime errors table above. The fault name is the last part of the fault code.	fault.name Matches "ScriptExecutionFailed"
pythonscript.policy_name.failed	policy_name is the user-specified name of the policy that threw the fault.	pythonscript.PythonScript-1.failed = true

Example error response

Note: For error handling, the best practice is to trap the errorcode part of the error response. Do not rely on the text in the faultstring, because it could change.

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

Example fault rule

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