Collegamento e configurazione di criteri nei file XML

Stai visualizzando la documentazione di Apigee Edge.
Consulta la documentazione di Apigee X. info

Puoi creare e modificare le policy localmente utilizzando l'editor di testo o XML o l'IDE che preferisci. Questo argomento utilizza il tipo di policy Quota 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 riportato di seguito, una policy Quota è configurata per limitare le app a 1 richiesta al minuto. Anche se potrebbe non essere realistico, fornisce un modo semplice per vedere gli effetti di una policy.

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

Ad esempio, una policy di tipo Quota denominata "QuotaPolicy" potrebbe essere creata 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 o generare la policy da uno schema XML. Tutte le policy hanno alcune impostazioni specifiche per il tipo di policy e alcune impostazioni generiche per tutte le policy.

Quando colleghi le policy nell'interfaccia utente di gestione, il generatore di proxy API genera l'istanza della policy dallo schema XML per il tipo di policy selezionato. Di conseguenza, nella configurazione della policy potresti visualizzare elementi che, per chiarezza, non sono sempre inclusi nella documentazione.

Tutte le policy definiscono i seguenti attributi:

  • enabled: indica se la policy è "attivata" o "disattivata". Le policy possono essere attivate/disattivate in fase di runtime modificando questa impostazione. Una policy con enabled impostato su false non viene applicata.
  • continueOnError: definisce se la pipeline deve continuare a elaborare il messaggio se la policy non riesce. Quando applichi le policy per le quote, è probabile che gli errori indichino 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 della policy e viene utilizzato per collegare la policy al flusso come passaggio di elaborazione.

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