Collegamento e configurazione di criteri nei file XML

Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione Documentazione di Apigee X. Informazioni

Puoi creare e modificare i criteri in locale utilizzando il tuo IDE o il tuo editor di testo o XML preferito. In questo argomento viene utilizzato il tipo di criteri per le quote 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 viene che possono richiamare un'API in un determinato intervallo di tempo. Nell'esempio seguente, un criterio per le quote configurate per limitare le app a 1 richiesta al minuto. Anche se potrebbe non essere realistico, offre un modo semplice per vedere gli effetti di una norma.

In una configurazione di proxy API, i file di criteri sono archiviati come file XML in Directory /apiproxy/policies.

Ad esempio, un criterio di tipo Quota denominato "QuotaPolicy" potrebbe essere creato come file denominato 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 oppure generare il criterio da uno schema XML. Tutti I criteri hanno alcune impostazioni specifiche per il tipo di criterio e alcune impostazioni che sono generiche in tutti i criteri.

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

Tutti i criteri definiscono i seguenti attributi:

  • enabled: indica se il criterio è attivo o meno. I criteri possono essere attivata/disattivata in fase di runtime modificando questa impostazione. Un criterio con enabled impostato su false non viene applicato.
  • continueOnError: definisce se la pipeline deve continuare a elaborare l'oggetto se il criterio non riesce. Quando applichi criteri per le quote, gli errori probabilmente indicano che quota è stata superata, pertanto questo attributo deve essere impostato su false.
  • name: il nome che assegni a questo criterio. Il nome è univoco dell'istanza del criterio e viene utilizzato per collegare il criterio al flusso come passaggio di elaborazione.
di Gemini Advanced.

Nell'esempio riportato sopra, gli elementi Allow, Interval e TimeUnit sono specifici per le norme relative alle quote. Questi elementi forniscono impostazioni che l'API L'applicazione dei servizi avviene per conto di un'API. Altri tipi di criteri definiscono le proprie impostazioni, che puoi impostare consulta la documentazione sulle norme.