Norme relative a PythonScript

Questa pagina si applica a Apigee e Apigee ibridi.

Visualizza la documentazione di Apigee Edge.

Cosa

Il criterio dello script Python ti consente di aggiungere funzionalità Python personalizzate al flusso del proxy API, soprattutto quando le funzionalità di cui hai bisogno vanno oltre i criteri pronti all'uso di Apigee. che fornisce.

Questo criterio è una norma estendibile e il suo utilizzo potrebbe comportare costi o di utilizzo delle applicazioni, a seconda della licenza Apigee. Per informazioni sui tipi di norme e le implicazioni sull'utilizzo, consulta Tipi di criteri.

Il supporto del linguaggio Python è fornito tramite Jython versione 2.5.2. Le librerie di terze parti aggiunte devono essere "pure Python" (implementate solo in Python). Per scoprire di più sull'aggiunta di librerie, consulta File di risorse.

Nota: questa funzionalità potrebbe non essere disponibile in tutti i piani Edge. Per sapere quale piano tariffario include questa funzionalità, consulta la pagina https://cloud.google.com/apigee/pricing/.

Un criterio Python non contiene codice effettivo. Un criterio Python fa riferimento invece a un file Python risorsa e definisce il passaggio nel flusso dell'API in cui viene eseguito lo script Python. Puoi caricare lo script tramite l'editor proxy dell'interfaccia utente di Apigee oppure includerlo nella directory /resources/py nei proxy API che sviluppi localmente.

ATTENZIONE:
devi limitare o disattivare l'accesso SSH alle tue risorse di sicurezza per impedire che questo criterio venga utilizzato per accedere ai file interni, alle informazioni utente correnti, all'elenco dei processi o all'utilizzo della CPU/della memoria.

Esempi

Criteri Python e copione

Criterio dello script Python

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

In questo esempio, l'elemento ResourceURL specifica lo script Python pertinente risorsa.

Script Python

Questo mostra cosa potresti includere nello script Python stesso.

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)

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

La tabella seguente descrive gli attributi comuni a tutti gli elementi principali dei criteri:

Attributo	Descrizione	Predefinito	Presenza
name	Il nome interno del criterio. Il valore dell'attributo name può Deve contenere lettere, numeri, spazi, trattini, trattini bassi e punti. Questo valore non può superare i 255 caratteri. Se vuoi, utilizza l'elemento <DisplayName> per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso in linguaggio naturale.	N/D	Obbligatorio
continueOnError	Imposta il valore su false per restituire un errore quando un criterio non funziona. Si tratta di un comportamento previsto comportamento per la maggior parte dei criteri. Imposta su true per continuare l'esecuzione del flusso anche dopo un fallimento del criterio. Vedi anche: Le regole di errore vengono attivate SOLO in uno stato di errore (informazioni su continueOnError) Gestione degli errori all'interno del flusso corrente	falso	Facoltativo
enabled	Imposta su true per applicare il criterio. Imposta false per disattivare il criterio. Il criterio non verrà applicata anche se rimane collegata a un flusso.	true	Facoltativo
async	Questo attributo è stato ritirato.	falso	Ritirato

<DisplayName> elemento

Da utilizzare in aggiunta all'attributo name per etichettare il criterio in editor proxy della UI di gestione con un nome diverso e in linguaggio naturale.

<DisplayName>Policy Display Name</DisplayName>

Predefinito	N/D Se ometti questo elemento, il valore dell'attributo name del criterio è in uso.
Presenza	Facoltativo
Tipo	Stringa

<ResourceURL> elemento

Questo elemento specifica il file Python principale che verrà eseguito nel flusso dell'API. Puoi archiviare questo file nell'ambito del proxy API (in /apiproxy/resources/py nel proxy API o nella sezione Script del riquadro di navigazione dell'editor del proxy API) o nella a livello di organizzazione o di ambiente per il riutilizzo in più proxy API, come descritto in File di risorse: Il tuo codice può utilizzare oggetti, metodi e proprietà del modello a oggetti JavaScript.

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

Valore predefinito:	Nessuno
Presenza:	Obbligatorio
Tipo:	Stringa

<IncludeURL> elemento

Specifica un file Python da caricare come dipendenza dal file Python principale specificato con Elemento <ResourceURL>. Gli script verranno valutati nell'ordine in cui sono elencati nel criterio.

Includi più di una risorsa di dipendenza Python con <IncludeURL> elementi.

Avviso: se i file Python sono archiviati nell'organizzazione o a livello di ambiente, assicurati che siano stati caricati correttamente con cURL utilizzando -F o come file allegato tramite un client REST. Il valore Content-Type è multipart/form-data. Per ulteriori informazioni, consulta File di risorse.

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

Predefinita:	Nessuno
Presenza:	Facoltativo
Tipo:	Stringa

Codici di errore

Questa sezione descrive i codici di errore e i messaggi di errore restituiti e le variabili di errore impostate da Apigee quando questo criterio attiva un errore. È importante conoscere queste informazioni se stai sviluppando regole di errore per gestire gli errori. Per scoprire di più, consulta Informazioni importanti sugli errori relativi alle norme e Gestione degli errori.

Errori di runtime

Questi errori possono verificarsi quando il criterio viene eseguito.

Suggerimento: hai bisogno di aiuto per risolvere un errore? Fai clic su nella colonna Correzione per informazioni dettagliate sulla risoluzione dei problemi.

Codice guasto	Stato HTTP	Causa	Correggi
steps.script.ScriptEvaluationFailed	500	Il criterio PythonScript può generare diversi tipi di errori ScriptExecutionFailed. Normalmente i tipi di errori riscontrati includono NameError e ZeroDivisionError.

Errori di deployment

Questi errori possono verificarsi quando esegui il deployment di un proxy contenente questo criterio.

Suggerimento: hai bisogno di aiuto per risolvere un errore? Clic accanto alla descrizione della causa dell'errore, per visitare la pagina di risoluzione dei problemi.

Nome errore	Causa	Correggi
InvalidResourceUrlFormat	Se il formato dell'URL della risorsa specificato all'interno di <ResourceURL> o l'elemento <IncludeURL> del criterio PythonScript non è valido, la distribuzione del proxy API non va a buon fine.
InvalidResourceUrlReference	Se gli elementi <ResourceURL> o <IncludeURL> fare riferimento a un file PythonScript che non esiste, il deployment del proxy API non va a buon fine. Il file di origine a cui viene fatto riferimento deve esistere a livello di organizzazione, di proxy API o di ambiente.

Variabili di errore

Queste variabili vengono impostate quando il criterio attiva un errore in fase di runtime. Per ulteriori informazioni, consulta Informazioni importanti sugli errori relativi alle norme.

Variabili	Dove	Esempio
fault.name="fault_name"	fault_name è il nome dell'errore, come elencato nella precedente tabella Errori di runtime. Il nome dell'errore è l'ultima parte del codice dell'errore.	fault.name Matches "ScriptExecutionFailed"
pythonscript.policy_name.failed	policy_name è il nome specificato dall'utente del criterio che ha generato l'errore.	pythonscript.PythonScript-1.failed = true

Esempio di risposta di errore

Nota: per la gestione degli errori, la best practice è il trap errorcode parte della risposta di errore. Non fare affidamento sul testo in faultstring, perché potrebbe cambiare.

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

Esempio di regola di errore

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