Criterio ResetQuota

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 &lt;Identifier&gt; 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 &lt;Identifier&gt;. In questo esempio, il criterio per la quota target non utilizza il tag &lt;Identifier&gt;, quindi specifichi l'attributo name come _default.

L'elemento &lt;Allow&gt; 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 &lt;Identifier&gt;, puoi specifica lo stesso valore al tag &lt;Identifier&gt; della reimpostazione della quota per aggiornare un conteggio delle quote specifico. Nota come il tag &lt;Identifier&gt; 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>

&lt;ResetQuota&gt; attributi

<ResetQuota async="false" continueOnError="false" enabled="true" name="Reset-Quota-1">

The following table describes attributes that are common to all policy parent elements:

Attribute Description Default Presence
name

The internal name of the policy. The value of the name attribute can contain letters, numbers, spaces, hyphens, underscores, and periods. This value cannot exceed 255 characters.

Optionally, use the <DisplayName> element to label the policy in the management UI proxy editor with a different, natural-language name.

 N/A Required
continueOnError

Set to false to return an error when a policy fails. This is expected behavior for most policies.

Set to true to have flow execution continue even after a policy fails.

 false Optional
enabled

Set to true to enforce the policy.

Set to false to turn off the policy. The policy will not be enforced even if it remains attached to a flow.

 true Optional
async

This attribute is deprecated.

 false Deprecated

<DisplayName> element

Use in addition to the name attribute to label the policy in the management UI proxy editor with a different, natural-language name.

<DisplayName>Policy Display Name</DisplayName>
Default

N/A

If you omit this element, the value of the policy's name attribute is used.
Presence Optional
Type String

&lt;Quota&gt; 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

&lt;Quota&gt;/&lt;Identifier&gt; elemento

Variabile utilizzata per identificare in modo univoco il contatore se il criterio per la quota di destinazione specifica Il tag &lt;Identifier&gt;. 

<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 &lt;Identifier&gt;, 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

&lt;Quota&gt;/&lt;Identifier&gt;/&lt;Allow&gt; elemento

Specifica l'importo per cui diminuire il contatore della quota. Devi specificare &lt;Allow&gt;, 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

&lt;Quota&gt;/&lt;Identifier&gt;/&lt;Class&gt; 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

This section describes the fault codes and error messages that are returned and fault variables that are set by Edge 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 Reset Quota 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 Reset Quota 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 Reset Quota Policy is not an integer, then the deployment of the API proxy fails.

Schemi

Argomenti correlati

Criteri per le quote