Criterio ResetQuota

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Utilizza i criteri ResetQuota per modificare dinamicamente il numero rimanente di richieste consentite dai criteri per le quote di destinazione. In genere, questo criterio viene utilizzato per diminuire il conteggio attuale delle quote del criterio Quota di destinazione anziché attendere il ripristino del conteggio delle quote.

Ad esempio, il criterio per le quote di destinazione limita 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 della quota e consentire 500 richieste aggiuntive 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.

Queste norme sono estendibili e il loro utilizzo potrebbe avere implicazioni in termini di costi o utilizzo, a seconda della licenza Apigee. Per informazioni sui tipi di policy e sulle implicazioni di utilizzo, consulta Tipi di policy.

Per saperne di più, consulta le norme relative alla quota. Consulta anche questo post della community sull'utilizzo della policy di reimpostazione della quota.

Esempi

Questi esempi di codice delle norme mostrano 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 per le quote di ripristino specifica il criterio per le quote di destinazione utilizzando l'attributo name del tag <Quota>. Nell'esempio precedente, la norma MyQuotaPolicy è la destinazione.

Tutte le policy di reimpostazione della quota richiedono il tag <Identifier> per specificare il contatore nella policy di quota da aggiornare. Per impostazione predefinita, una norma per le quote ha un solo contatore, a meno che non includa anche il tag <Identifier>. In questo esempio, la norma relativa alla quota di destinazione non utilizza il tag <Identifier>, quindi devi specificare l'attributo name come _default.

L'elemento <Allow> specifica il valore utilizzato per diminuire il conteggio della quota corrente nel criterio di destinazione. In questo esempio, il conteggio della quota viene ridotto di 100, per consentire altre 100 richieste al criterio per le quote di destinazione. Quando il criterio Quota target viene reimpostato, questa modifica viene annullata.

Di seguito è riportata la definizione del criterio per le quote di destinazione:

<Quota name="MyQuotaPolicy">
  <Interval>5</Interval>
  <TimeUnit>hour</TimeUnit>
  <Allow count="100"/>
</Quota>

Utilizzare un riferimento

<ResetQuota name="resetQuota">
   <Quota ref="request.header.quotapolicy">
      <Identifier name="_default">
         <Allow ref="request.header.allowquota" />
      </Identifier>
   </Quota>
</ResetQuota>

In questo esempio, trasmetti il nome del criterio di quota di destinazione 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 le quote di destinazione specifica il tag <Identifier>, puoi specificare lo stesso valore per il tag <Identifier> del criterio per le quote di reimpostazione per aggiornare un conteggio delle quote specifico. Nota come il tag <Identifier> nel criterio per le quote di destinazione di seguito corrisponda al valore specificato per il criterio per le quote di reimpostazione: 

<Quota name="QuotaPolicy">
  <Identifier ref="request.header.clientId"/>
  <Interval>5</Interval>
  <TimeUnit>hour</TimeUnit>
  <Allow count="100"/>
</Quota>

Riferimento elemento

Il riferimento all'elemento 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 Presence
name

Il nome interno del criterio. Il valore dell'attributo name può contenere lettere, numeri, spazi, trattini, trattini bassi e punti. Questo valore non può superare i 255 caratteri.

Se vuoi, utilizza l'elemento <DisplayName> per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso in linguaggio naturale.

 N/D Obbligatorio
continueOnError

Imposta su false per restituire un errore quando un criterio non va a buon fine. Questo è un comportamento previsto per la maggior parte dei criteri.

Imposta su true per continuare l'esecuzione del flusso anche dopo un fallimento del criterio. Vedi anche:

 falso Facoltativo
enabled

Imposta su true per applicare il criterio.

Imposta su false per disattivare il criterio. Il criterio non verrà applicato anche se rimane collegato a un flusso.

 true Facoltativo
async

Questo attributo è stato ritirato.

 falso Deprecato

Elemento <DisplayName>

Da utilizzare insieme 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/D

Se ometti questo elemento, viene utilizzato il valore dell'attributo name del criterio.
Presence Facoltativo
Tipo Stringa

Elemento <Quota>

Identifica la norma relativa alla 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>
Valore predefinito: N/D
Presenza: Obbligatorio
Tipo: N/D

Attributi

Attributo Descrizione Predefinito Presenza
nome

Specifica il nome della policy di quota di destinazione.

N/D Facoltativo
ref Una variabile di flusso che contiene il nome della policy di quota di destinazione. Se vengono specificati sia ref che name, ref ha la priorità. Se ref non viene risolto in fase di runtime, viene utilizzato name. N/D Facoltativo

Elemento <Quota>/<Identifier>

Variabile utilizzata per identificare in modo univoco il contatore se il criterio per le quote di destinazione specifica il tag <Identifier>. 

<Quota name="quotaName">
   <Identifier name="identifierName" ref="request.header.identifier">
      <Allow>100</Allow>
   </Identifier>
</Quota>
Valore predefinito: N/D
Presenza: Obbligatorio
Tipo: Stringa

Attributi

Attributo Descrizione Predefinito Presenza
nome

Specifica il nome dell'identificatore del conteggio nella norma relativa alla quota di destinazione. Per una norma Quota che non utilizza il tag <Identifier>, specifica _default.

 N/D Facoltativo
ref

Una variabile di flusso che contiene il nome dell'identificatore del conteggio nel criterio di quota di destinazione. Se vengono specificati sia ref che name, ref ha la priorità. Se ref non viene risolto in fase di runtime, viene utilizzato name.

 N/D Facoltativo

Elemento <Quota>/<Identifier>/<Allow>

Specifica l'importo per diminuire il contatore della quota. Devi specificare <Allow>, altrimenti la policy non modifica la quota.

<Identifier name="identifierName" ref="request.header.identifier">
   <Allow ref="request.header.allowquota">100</Allow>
</Identifier>
Valore predefinito: N/D
Presenza: Obbligatorio
Tipo: Numero intero

Attributi

Attributo Descrizione Predefinito Presenza
ref

Una variabile di flusso che contiene la modifica al conteggio della quota nel criterio di quota di destinazione.

N/D Facoltativo

Elemento <Quota>/<Identifier>/<Class>

Specifica la classe per cui viene aggiornato il contatore della quota. Per ulteriori informazioni sull'utilizzo della classe con la policy relativa alle quote, consulta Policy relative alle quote. 

<Identifier name="_default">
   <Class ref="request.header.classIdentifier">
     <Allow>200</Allow>
   </Class>
</Identifier>
Valore predefinito: N/D
Presenza: Facoltativo
Tipo: N/D

Attributi

Attributo Descrizione Predefinito Presenza
ref

Riferimento alla variabile di flusso che contiene la classe di quota da aggiornare.

 N/D Facoltativo

Messaggi di errore

This section describes the fault codes and error messages that are returned and fault variables that are set by Apigee when this policy triggers an error. This information is important to know if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Fault code HTTP status Cause Fix
policies.resetquota.InvalidRLPolicy 500 The Quota policy specified in the <Quota> element of the ResetQuota policy is not defined in the API proxy and thus is not available during the flow. The <Quota> element is mandatory and identifies the target Quota policy whose counter should be updated through the ResetQuota policy.
policies.resetquota.FailedToResolveAllowCountRef N/A The reference to the variable containing the allow count in the <Allow> element of the policy cannot be resolved to a value. This element is mandatory and specifies the amount to decrease the quota counter.
policies.resetquota.FailedToResolveRLPolicy 500 The variable referenced by the ref attribute in the <Quota> element cannot be resolved.

Deployment errors

These errors can occur when you deploy a proxy containing this policy.

Error name Cause Fix
InvalidCount If the count value specified in the <Allow> element of the ResetQuota Policy is not an integer, then the deployment of the API proxy fails.

Schemi

Argomenti correlati

Criteri per le quote