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 le policy localmente utilizzando il tuo editor di testo o IDE preferito. Questo argomento utilizza il tipo di policy relative alle quote come esempio di come creare, configurare, collegare, eseguire il deployment e testare le policy.

La maggior parte dei proxy API applica una quota. Le quote forniscono il controllo sulla frequenza con cui un'app client è autorizzata a richiamare un'API in un determinato intervallo di tempo. Nell'esempio seguente, un criterio per le quote è configurato per limitare le app a 1 richiesta al minuto. Anche se potrebbe non essere realistico, questo fornisce un modo semplice per vedere gli effetti di un criterio.

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

Ad esempio, una policy di tipo Quota denominata Quota Policy potrebbe essere creata come file denominato QuotaPolicy.xml con il seguente contenuto:

<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 criteri e altre generiche per tutti i criteri.

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

Tutte le policy definiscono i seguenti attributi:

  • enabled: indica se il criterio è attivato o disattivato. I criteri possono essere attivati/disattivati 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 il messaggio se la policy non va a buon fine. Quando vengono applicate le norme relative alle quote, gli errori indicano probabilmente che la quota è stata superata e, pertanto, questo attributo deve essere impostato su false.
  • name: Il nome che assegni a questa policy. Questo nome è univoco per questa istanza del criterio e viene utilizzato per collegare il criterio al flusso come passaggio di elaborazione.

Nell'esempio precedente, gli elementi Allow, Interval e TimeUnit sono specifici della policy relativa alle quote. Questi elementi forniscono impostazioni che i servizi API applicano per conto di un'API. Altri tipi di policy definiscono le proprie impostazioni, che puoi consultare nel riferimento alle policy.