Política de PythonScript

Esta página aplica-se ao Apigee e ao Apigee Hybrid.

Veja a documentação do Apigee Edge.

A política de script Python permite-lhe adicionar funcionalidades Python personalizadas ao fluxo do proxy de API, especialmente quando a funcionalidade de que precisa está além do que as políticas prontas a usar do Apigee oferecem.

Esta política é uma política extensível e a utilização desta política pode ter implicações de custo ou utilização, consoante a sua licença do Apigee. Para ver informações sobre os tipos de políticas e as implicações de utilização, consulte Tipos de políticas.

O suporte do idioma Python é fornecido através da versão 2.5.2 do Jython. As bibliotecas de terceiros que adicionar têm de ser "Python puro" (implementadas apenas em Python). Para mais informações sobre como adicionar bibliotecas, consulte o artigo Ficheiros de recursos.

Nota: esta funcionalidade pode não estar disponível em todos os planos do Apigee. Para ver que plano de preços inclui esta funcionalidade, consulte https://cloud.google.com/apigee/pricing/.

Uma política do Python não contém código real. Em alternativa, uma política Python faz referência a um recurso Python e define o passo no fluxo da API em que o guião Python é executado. Pode carregar o script através do editor de proxy da IU do Apigee ou incluí-lo no diretório /resources/py em proxies de API que desenvolve localmente.

AVISO:
deve limitar ou desativar o acesso SSH aos seus recursos de segurança para impedir que esta política seja usada para aceder a ficheiros internos, informações do utilizador atuais, a lista de processos ou a utilização da CPU/memória.

Amostras

Política e script Python

Política de scripts Python

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

Neste exemplo, o elemento ResourceURL especifica o recurso de script Python relevante.

Script Python

Isto mostra o que pode incluir no próprio script 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)

Referência do 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>

A tabela seguinte descreve os atributos comuns a todos os elementos principais de políticas:

Atributo	Descrição	Predefinição	Presença
name	O nome interno da política. O valor do atributo name pode conter letras, números, espaços, hífenes, sublinhados e pontos finais. Este valor não pode exceder 255 carateres. Opcionalmente, use o elemento <DisplayName> para etiquetar a política no editor de proxy da IU de gestão com um nome diferente em linguagem natural.	N/A	Obrigatória
continueOnError	Definido como false para devolver um erro quando uma política falha. Este comportamento é o esperado para a maioria das políticas. Definido como true para que a execução do fluxo continue mesmo depois de uma política falhar. Veja também: As regras de falhas são acionadas APENAS num estado de erro (acerca de continueOnError) Processar falhas no fluxo atual	falso	Opcional
enabled	Defina como true para aplicar a política. Defina como false para desativar a política. A política não é aplicada, mesmo que permaneça associada a um fluxo.	verdadeiro	Opcional
async	Este atributo foi descontinuado.	falso	Descontinuado

Elemento <DisplayName>

Use em conjunto com o atributo name para etiquetar a política no editor de proxy da IU de gestão com um nome diferente em linguagem natural.

<DisplayName>Policy Display Name</DisplayName>

Predefinição	N/A Se omitir este elemento, é usado o valor do atributo name da política.
Presença	Opcional
Tipo	String

Elemento <ResourceURL>

Este elemento especifica o ficheiro Python principal que vai ser executado no fluxo da API. Pode armazenar este ficheiro no âmbito do proxy de API (em /apiproxy/resources/py no pacote do proxy de API ou na secção Scripts do painel Navigator do editor do proxy de API) ou nos âmbitos da organização ou do ambiente para reutilização em vários proxies de API, conforme descrito em Ficheiros de recursos. O seu código pode usar os objetos, os métodos e as propriedades do modelo de objetos JavaScript.

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

Predefinição:	Nenhum
Presença:	Obrigatória
Tipo:	String

Elemento<IncludeURL>

Especifica um ficheiro Python a ser carregado como dependência do ficheiro Python principal especificado com o elemento <ResourceURL>. Os scripts são avaliados pela ordem em que são apresentados na política.

Inclua mais do que um recurso de dependência do Python com elementos <IncludeURL> adicionais.

Aviso: se os seus ficheiros Python estiverem armazenados ao nível do proxy ou do ambiente, certifique-se de que foram carregados corretamente com o cURL através da opção -F ou como anexo de ficheiro através de um cliente REST. Content-Type é multipart/form-data. Para mais informações, consulte o artigo Ficheiros de recursos.

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

Predefinição:	Nenhum
Presença:	Opcional
Tipo:	String

Códigos de erro

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>