Collegamento e configurazione di criteri nei file XML

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Puoi creare e modificare i criteri localmente utilizzando il tuo editor o IDE di testo o XML preferito. Questo argomento utilizza il tipo di criterio Quota come esempio di come creare, configurare, collegare, eseguire il deployment e testare i criteri.

La maggior parte dei proxy API applica una quota. Le quote consentono di controllare la frequenza con cui un'app client è autorizzata a invocare un'API in un determinato intervallo di tempo. Nell'esempio seguente, un criterio per le quote è configurato per limitare le app a una richiesta al minuto. Anche se potrebbe non essere realistico, offre un modo semplice per vedere gli effetti di una norma.

In una configurazione del proxy API, i file di criteri vengono archiviati come file XML nella directory /apiproxy/policies.

Ad esempio, un criterio di tipo Quota denominato Criterio quota potrebbe essere creato come file chiamato QuotaPolicy.xml con i seguenti contenuti:

<Quota enabled="true" continueOnError="false" name="QuotaPolicy">
    <Allow count="1"/>
    <Interval>1</Interval>
    <TimeUnit>minute</TimeUnit>
</Quota>

Puoi creare un file di testo manualmente o generare il criterio da uno schema XML. Tutti i criteri hanno alcune impostazioni specifiche per il tipo di criterio e alcune impostazioni generiche per tutti i criteri.

Quando colleghi i criteri nell'interfaccia utente di gestione, lo strumento per la creazione di proxy API genera l'istanza del criterio dallo schema XML per il tipo di criterio selezionato. Di conseguenza, nella configurazione dei criteri potresti visualizzare elementi che, per chiarezza, non sono sempre inclusi nella documentazione.

Tutti i criteri definiscono i seguenti attributi:

• enabled: indica se il criterio è attivato o disattivato. I criteri possono essere attivati/disattivati in fase di esecuzione modificando questa impostazione. Un criterio con enabled impostato su false non viene applicato.
• continueOnError: definisce se la pipeline deve continuare a elaborare il messaggio se il criterio non va a buon fine. Quando vengono applicati i criteri di quota, gli errori indicano probabilmente che la quota è stata superata e, pertanto, questo attributo deve essere impostato su false.
• name: il nome assegnato a questo criterio. Questo nome è univoco per questa istanza del criterio e viene utilizzato per collegare il criterio al flusso come passaggio di elaborazione.

Nota: a parte name, raramente è necessario modificare le impostazioni predefinite per questi attributi dei criteri. Per questo motivo e per chiarezza, spesso vengono esclusi dai modelli di norme nella documentazione.

Nell'esempio riportato sopra, gli elementi Allow, Interval e TimeUnit sono specifici per le norme relative alle quote. Questi elementi forniscono le impostazioni applicate da API Services per conto di un'API. Gli altri tipi di criteri definiscono le proprie impostazioni, che puoi approfondire nel Documentazione di riferimento dei criteri.