Stai visualizzando la documentazione di Apigee Edge.
Vai alla sezione
Documentazione di Apigee X. Informazioni
Cosa
Utilizza questa opzione per modificare in modo dinamico il numero rimanente di richieste consentite dal criterio per la quota di destinazione. In genere, questo criterio viene utilizzato per ridurre il conteggio della quota attuale del criterio per la quota target anziché attendere la reimpostazione del conteggio delle quote.
Ad esempio, i criteri per le quote target limitano uno sviluppatore a 1000 richieste a settimana. Dal secondo giorno della settimana, lo sviluppatore ha già raggiunto questo limite. Utilizza il criterio per la reimpostazione della quota di sottrarre 500 dal contatore della quota per consentire altre 500 richieste per il resto durante la settimana. Alla fine della settimana, il criterio per le quote viene reimpostato e lo sviluppatore torna a 1000 più richieste per la settimana.
Consulta i criteri per le quote per saperne di più i criteri per le quote. Vedi anche questo articolo post della community sull'uso del criterio Reimposta quota.
Esempi
Questi esempi di codice dei criteri illustrano come reimpostare i contatori delle quote:
Reimposta contatore predefinito
<ResetQuota name="resetQuota">
<Quota name="MyQuotaPolicy">
<Identifier name="_default">
<Allow>100</Allow>
</Identifier>
</Quota>
</ResetQuota>
Il criterio Reimposta quota specifica il criterio per la quota target utilizzando l'attributo name del tag <Quota>. Nell'esempio precedente, il criterio MyQuotaPolicy è il target.
Tutti i criteri di reimpostazione della quota richiedono che il tag <Identifier> specifichi nel criterio per le quote da aggiornare. Per impostazione predefinita, un criterio per le quote ha un unico contatore, a meno che i criteri per le quote includano anche il tag <Identifier>. In questo esempio, il criterio per la quota target non utilizza il tag <Identifier>, quindi specifichi l'attributo name come _default.
L'elemento <Allow> specifica il valore utilizzato per ridurre il conteggio delle quote attuale sul criterio di destinazione. In questo Ad esempio, il conteggio della quota viene diminuito di 100, per consentire altre 100 richieste alla quota target . Quando il criterio per la quota target viene reimpostato, questa modifica viene ignorata.
Di seguito è riportata la definizione dei criteri per la quota target:
<Quota name="MyQuotaPolicy"> <Interval>5</Interval> <TimeUnit>hour</TimeUnit> <Allow count="100"/> </Quota>
Utilizza un riferimento
<ResetQuota name="resetQuota">
<Quota ref="request.header.quotapolicy">
<Identifier name="_default">
<Allow ref="request.header.allowquota" />
</Identifier>
</Quota>
</ResetQuota>
In questo esempio, passi il nome del criterio per la quota target e la modifica della relativa quota come intestazioni nella richiesta. Puoi quindi fare riferimento alle variabili di flusso che contengono questi nel criterio Reimposta quota.
Specifica l'identificatore
<ResetQuota name="resetQuota">
<Quota name="QuotaPolicy">
<Identifier ref="request.header.clientId">
<Allow>100</Allow>
</Identifier>
</Quota>
</ResetQuota>
Se il criterio per la quota target specifica il tag <Identifier>, puoi specifica lo stesso valore al tag <Identifier> della reimpostazione della quota per aggiornare un conteggio delle quote specifico. Nota come il tag <Identifier> nella configurazione Il criterio per le quote seguente corrisponde al valore specificato nel criterio Reimposta quota:
<Quota name="QuotaPolicy"> <Identifier ref="request.header.clientId"/> <Interval>5</Interval> <TimeUnit>hour</TimeUnit> <Allow count="100"/> </Quota>
Riferimento elemento
Il riferimento agli elementi descrive gli elementi e gli attributi del criterio Reimposta quota.
<ResetQuota async="false" continueOnError="false" enabled="true" name="Reset-Quota-1">
<DisplayName>Reset Quota 1</DisplayName>
<Quota name="quotaName" ref="request.header.quotapolicy">
<Identifier name="identifierName" ref="request.header.identifier">
<Class ref="request.header.classIdentifier" />
<Allow>100</Allow>
</Identifier>
</Quota>
</ResetQuota>
<ResetQuota> attributi
<ResetQuota async="false" continueOnError="false" enabled="true" name="Reset-Quota-1">
La tabella seguente descrive gli attributi comuni a tutti gli elementi principali del criterio:
| Attributo | Descrizione | Predefinito | Presenza |
|---|---|---|---|
name |
Il nome interno del criterio. Il valore dell'attributo Se vuoi, puoi utilizzare l'elemento |
N/D | Obbligatorio |
continueOnError |
Imposta il valore su Imposta su |
falso | Facoltativo |
enabled |
Imposta il valore su Imposta |
true | Facoltativo |
async |
Questo attributo è obsoleto. |
falso | Deprecato |
<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 |
|---|---|
| Presenza | Facoltativo |
| Tipo | Stringa |
<Quota> elemento
Identifica il criterio per la quota di destinazione il cui contatore deve essere aggiornato.
<Quota name="quotaName" ref="request.header.quotapolicy">
<Identifier name="identifierName" ref="request.header.identifier">
<Allow>100</Allow>
</Identifier>
</Quota>
| Predefinita: | N/D |
| Presenza: | Obbligatorio |
| Tipo: | N/D |
Attributi
| Attributo | Descrizione | Predefinito | Presenza |
|---|---|---|---|
| nome |
Specifica il nome del criterio per la quota target. |
N/D | Facoltativo |
| riferimento | Una variabile di flusso che contiene il nome del criterio per la quota target. Se sono specificati sia ref che name, allora ref ottiene la priorità. Se ref sì non risolvi in fase di runtime, viene utilizzato name. | N/D | Facoltativo |
<Quota>/<Identifier> elemento
Variabile utilizzata per identificare in modo univoco il contatore se il criterio per la quota di destinazione specifica Il tag <Identifier>.
<Quota name="quotaName">
<Identifier name="identifierName" ref="request.header.identifier">
<Allow>100</Allow>
</Identifier>
</Quota>
| Predefinita: | N/D |
| Presenza: | Obbligatorio |
| Tipo: | Stringa |
Attributi
| Attributo | Descrizione | Predefinito | Presenza |
|---|---|---|---|
| nome |
Specifica il nome dell'identificatore del conteggio nel criterio per la quota di destinazione. Per una quota criterio che non utilizza il tag <Identifier>, specifica _default. |
N/D | Facoltativo |
| riferimento |
Una variabile di flusso che contiene il nome dell'identificatore del conteggio nella quota di destinazione . Se sono specificati sia ref che name, allora ref ottiene la priorità. Se ref non si risolve in runtime, viene utilizzato name. |
N/D | Facoltativo |
<Quota>/<Identifier>/<Allow> elemento
Specifica l'importo per cui diminuire il contatore della quota. Devi specificare <Allow>, altrimenti il criterio non modificare la quota.
<Identifier name="identifierName" ref="request.header.identifier"> <Allow ref="request.header.allowquota">100</Allow> </Identifier>
| Predefinita: | N/D |
| Presenza: | Obbligatorio |
| Tipo: | Numero intero |
Attributi
| Attributo | Descrizione | Predefinito | Presenza |
|---|---|---|---|
| riferimento |
Una variabile di flusso contenente la modifica al conteggio delle quote nel criterio per la quota di destinazione. |
N/D | Facoltativo |
<Quota>/<Identifier>/<Class> elemento
Specifica la classe per la quale viene aggiornato il contatore della quota. Per ulteriori informazioni sull'utilizzo di class con Per i criteri per le quote, consulta la sezione Quota .
<Identifier name="_default">
<Class ref="request.header.classIdentifier">
<Allow>200</Allow>
</Class>
</Identifier>
| Predefinita: | N/D |
| Presenza: | Facoltativo |
| Tipo: | N/D |
Attributi
| Attributo | Descrizione | Predefinito | Presenza |
|---|---|---|---|
| riferimento |
Riferimento alla variabile di flusso che contiene la classe di quota da aggiornare. |
N/D | Facoltativo |
Messaggi di errore
Questa sezione descrive i codici e i messaggi di errore restituiti e le variabili di errore impostate da Edge quando questo criterio attiva un errore. Queste informazioni sono importanti per sapere se si stanno sviluppando regole di errore per gestire gli errori. Per scoprire di più, consulta gli articoli Cosa devi sapere sugli errori relativi alle norme e Gestione degli errori.
Errori di runtime
Questi errori possono verificarsi quando il criterio viene eseguito.
| Codice di errore | Stato HTTP | Causa | Correggi |
|---|---|---|---|
policies.resetquota.InvalidRLPolicy |
500 | Il criterio per le quote specificato nell'elemento <Quota> del criterio di reimpostazione della quota non è definito nel proxy API e, di conseguenza, non è disponibile durante il flusso. L'elemento <Quota> è obbligatorio e identifica il criterio per le quote di destinazione il cui contatore deve essere aggiornato tramite il criterio di reimpostazione della quota. |
build |
policies.resetquota.FailedToResolveAllowCountRef |
N/A | Il riferimento alla variabile contenente il conteggio di autorizzazioni nell'elemento <Allow> del criterio non può essere risolto in un valore. Questo elemento è obbligatorio e specifica la quantità
per diminuire il contatore di quota. |
build |
policies.resetquota.FailedToResolveRLPolicy |
500 | La variabile a cui fa riferimento l'attributo ref nell'elemento <Quota>
non può essere risolta. |
build |
Errori di deployment
Questi errori possono verificarsi quando esegui il deployment di un proxy contenente questo criterio.
| Nome errore | Causa | Correggi |
|---|---|---|
InvalidCount |
Se il valore di conteggio specificato nell'elemento <Allow> del criterio di reimpostazione della quota non è un numero intero, il deployment del proxy API non riesce.
|
build |