Questa pagina si applica a Apigee e Apigee ibrido.
Visualizza la documentazione di
Apigee Edge.
Cosa
Utilizza questa opzione per modificare in modo dinamico il numero rimanente di richieste consentite dal criterio per la quota di destinazione. In genere, puoi utilizzare questo criterio per ridurre il conteggio della quota attuale del criterio per la quota di destinazione anziché attendere la reimpostazione del conteggio delle quote.
Ad esempio, i criteri per le quote target limitano uno sviluppatore a 1000 richieste a settimana. Entro il secondo giorno della settimana, lo sviluppatore ha già raggiunto questo limite. Utilizza il criterio Reimposta quota per sottrarre 500 dal contatore delle quote e consentire altre 500 richieste per il resto della settimana. Alla fine della settimana, il criterio per le quote viene reimpostato e lo sviluppatore torna a 1000 richieste per la settimana.
Questo criterio è un criterio estendibile e il suo utilizzo potrebbe avere implicazioni in termini di costi o utilizzo, a seconda della licenza Apigee. Per informazioni sui tipi di criteri e sulle implicazioni per l'utilizzo, consulta la pagina Tipi di criteri.
Consulta i criteri per le quote per saperne di più sui criteri per le quote. Leggi anche questo post della community sull'utilizzo del criterio per la reimpostazione della 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 riportato sopra, il criterio MyQuotaPolicy è il target.
Tutti i criteri di reimpostazione della quota richiedono al tag <Identifier> di specificare il contatore da aggiornare nel criterio per le quote. Per impostazione predefinita, un criterio per le quote ha un singolo contatore, a meno che il criterio per le quote non includa 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 diminuire il conteggio della quota attuale per il criterio di destinazione. In questo esempio, il conteggio delle quote viene ridotto di 100, per consentire altre 100 richieste al criterio della 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 del conteggio della quota come intestazioni nella richiesta. Puoi quindi fare riferimento alle variabili di flusso contenenti questi valori 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 specificare lo stesso valore per il tag <Identifier> del criterio Reimposta quota per aggiornare un conteggio di quota specifico. Osserva che il tag <Identifier> nel criterio per la quota di destinazione riportato di seguito 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>
Attributi <ResetQuota>
<ResetQuota async="false" continueOnError="false" enabled="true" name="Reset-Quota-1">
La tabella seguente descrive gli attributi comuni a tutti gli elementi principali dei criteri:
| Attributo | Descrizione | Predefinito | Presenza |
|---|---|---|---|
name |
Il nome interno della norma. Il valore dell'attributo Facoltativamente, utilizza l'elemento |
N/A | Obbligatorio |
continueOnError |
Impostalo su Imposta su |
false | Facoltativo |
enabled |
Imposta il criterio su Impostala su |
true | Facoltativo |
async |
Questo attributo è obsoleto. |
false | Deprecata |
Elemento <DisplayName>
Utilizzalo in aggiunta all'attributo name per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso in linguaggio naturale.
<DisplayName>Policy Display Name</DisplayName>
| Predefinito |
N/A Se ometti questo elemento, viene utilizzato il valore dell'attributo |
|---|---|
| Presenza | Facoltativo |
| Tipo | Stringa |
Elemento <Quota>
Identifica il criterio per la quota target 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/A |
| Presenza: | Obbligatorio |
| Tipo: | N/A |
Attributi
| Attributo | Descrizione | Predefinita | Presenza |
|---|---|---|---|
| nome |
Specifica il nome del criterio per la quota target. |
N/A | Facoltativo |
| riferimento | Una variabile di flusso che contiene il nome del criterio per la quota target. Se sono specificati sia ref che name, ref ha la priorità. Se ref non si risolve in fase di runtime, viene utilizzato name. | N/A | Facoltativo |
Elemento <Quota>/<Identifier>
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/A |
| Presenza: | Obbligatorio |
| Tipo: | String |
Attributi
| Attributo | Descrizione | Predefinita | Presenza |
|---|---|---|---|
| nome |
Specifica il nome dell'identificatore del conteggio nel criterio per la quota di destinazione. Per un criterio per le quote che non utilizza il tag <Identifier>, specifica _default. |
N/A | Facoltativo |
| riferimento |
Una variabile di flusso che contiene il nome dell'identificatore del conteggio nel criterio per la quota di destinazione. Se sono specificati sia ref che name, ref ha la priorità. Se ref non si risolve in fase di runtime, viene utilizzato name. |
N/A | Facoltativo |
Elemento <Quota>/<Identifier>/<Allow>
Specifica l'importo in base al quale ridurre il contatore della quota. Devi specificare <Allow>, altrimenti il criterio non modifica la quota.
<Identifier name="identifierName" ref="request.header.identifier"> <Allow ref="request.header.allowquota">100</Allow> </Identifier>
| Predefinita: | N/A |
| Presenza: | Obbligatorio |
| Tipo: | Integer |
Attributi
| Attributo | Descrizione | Predefinita | Presenza |
|---|---|---|---|
| riferimento |
Una variabile di flusso contenente la modifica al conteggio delle quote nel criterio per la quota di destinazione. |
N/A | Facoltativo |
Elemento <Quota>/<Identifier>/<Class>
Specifica la classe per la quale viene aggiornato il contatore della quota. Per saperne di più sull'utilizzo della classe con i criteri per le quote, consulta i criteri per le quote.
<Identifier name="_default">
<Class ref="request.header.classIdentifier">
<Allow>200</Allow>
</Class>
</Identifier>
| Predefinita: | N/A |
| Presenza: | Facoltativo |
| Tipo: | N/A |
Attributi
| Attributo | Descrizione | Predefinita | Presenza |
|---|---|---|---|
| riferimento |
Riferimento alla variabile di flusso che contiene la classe di quota da aggiornare. |
N/A | Facoltativo |
Messaggi di errore
Questa sezione descrive i codici e i messaggi di errore restituiti, nonché le variabili di errore impostate da Apigee quando questo criterio attiva un errore. È importante sapere se stai sviluppando regole di errore per gestire gli errori. Per saperne di più, consulta le sezioni Cosa devi sapere sugli errori dei criteri 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 Quota specificato nell'elemento <Quota> del criterio ResetQuota non è definito nel proxy API e pertanto non è disponibile durante il flusso. L'elemento <Quota> è obbligatorio e identifica il criterio Quota di destinazione il cui contatore deve essere aggiornato tramite il criterio ResetQuota. |
build |
policies.resetquota.FailedToResolveAllowCountRef |
N/A | Il riferimento alla variabile contenente il conteggio consentito nell'elemento <Allow>
del criterio non può essere risolto in un valore. Questo elemento è obbligatorio e specifica l'importo necessario per diminuire il contatore della 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 ResetQuota non è un numero intero, il deployment del proxy API non va a buon fine.
|
build |