Criterio ResetQuota

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

Cosa

Utilizza questa policy per modificare in modo dinamico il numero rimanente di richieste consentite dalla policy per le quote di destinazione. In genere, questa policy viene utilizzata per diminuire il conteggio delle quote corrente della policy per le quote di destinazione anziché attendere il ripristino del conteggio delle quote.

Ad esempio, la policy 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 la policy Reset Quota per sottrarre 500 dal contatore delle quote e consentire altre 500 richieste per il resto della settimana. Alla fine della settimana, la policy per le quote viene reimpostata e lo sviluppatore torna a 1000 richieste per la settimana.

Per ulteriori informazioni sulla policy per le quote, consulta Policy per le quote. Consulta anche questo post della community sull'utilizzo della policy Reset Quota.

Esempi

Questi esempi di codice della policy 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>

La policy Reset Quota specifica la policy per le quote di destinazione utilizzando l'attributo name del tag <Quota>. Nell'esempio precedente, la policy MyQuotaPolicy è la destinazione.

Tutte le policy Reset Quota richiedono il tag <Identifier> per specificare il contatore nella policy per le quote da aggiornare. Per impostazione predefinita, una policy per le quote ha un singolo contatore, a meno che non includa anche il tag <Identifier>. In questo esempio, la policy per le quote 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 delle quote corrente nella policy di destinazione. In questo esempio, il conteggio delle quote viene diminuito di 100, per consentire altre 100 richieste alla policy per le quote di destinazione. Quando la policy per le quote di destinazione viene reimpostata, questa modifica viene ignorata.

Di seguito è riportata la definizione della policy per le quote di destinazione:

<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, trasmetti il nome della policy per le quote di destinazione e la modifica al conteggio delle quote come intestazioni nella richiesta. Puoi quindi fare riferimento alle variabili di flusso contenenti questi valori nella policy Reset Quota.

Specifica l'identificatore

<ResetQuota name="resetQuota">
   <Quota name="QuotaPolicy">
      <Identifier ref="request.header.clientId">
         <Allow>100</Allow>
      </Identifier>
   </Quota>
</ResetQuota>

Se la policy per le quote di destinazione specifica il tag <Identifier>, puoi specificare lo stesso valore per il tag <Identifier> della policy Reset Quota per aggiornare un conteggio delle quote specifico. Nota come il tag <Identifier> nella policy per le quote di destinazione riportata di seguito corrisponda al valore specificato per la policy Reset Quota: 

<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 della policy Reset 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 del criterio:

Attributo Descrizione Predefinito Presenza
name

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

Se vuoi, puoi utilizzare l'elemento <DisplayName> per etichettare il criterio in l'editor proxy della UI di gestione con un nome diverso in linguaggio naturale.

 N/D Obbligatorio
continueOnError

Imposta il valore su false per restituire un errore quando un criterio non viene eseguito. Si tratta di un comportamento previsto per la maggior parte dei criteri.

Imposta su true per fare in modo che l'esecuzione del flusso continui anche dopo un criterio non riesce.

 falso Facoltativo
enabled

Imposta il valore su true per applicare il criterio.

Imposta false per disattivare il criterio. Il criterio non verrà applicata anche se rimane collegata a un flusso.

 true Facoltativo
async

Questo attributo è obsoleto.

 falso Deprecato

&lt;DisplayName&gt; 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 name del criterio è in uso.
Presenza Facoltativo
Tipo Stringa

Elemento <Quota>

Identifica la policy per le quote 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>
Predefinito: N/D
Presenza: Obbligatorio
Tipo: N/D

Attributi

Attributo Descrizione Predefinito Presenza
name

Specifica il nome della policy per le quote di destinazione.

N/D Facoltativo
ref Una variabile di flusso che contiene il nome della policy per le quote 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 la policy per le quote di destinazione specifica il <Identifier> tag. 

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

Attributi

Attributo Descrizione Predefinito Presenza
name

Specifica il nome dell'identificatore del conteggio nella policy per le quote di destinazione. Per una policy per le quote che non utilizza il <Identifier> tag, specifica _default.

 N/D Facoltativo
ref

Una variabile di flusso che contiene il nome dell'identificatore del conteggio nella policy per le quote di destinazione. Se vengono specificati sia ref che name, allora 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 di cui diminuire il contatore delle quote. 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>
Predefinito: N/D
Presenza: Obbligatorio
Tipo: Numero intero

Attributi

Attributo Descrizione Predefinito Presenza
ref

Una variabile di flusso che contiene la modifica al conteggio delle quote nella policy per le quote di destinazione.

N/D Facoltativo

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

Specifica la classe per cui viene aggiornato il contatore delle quote. Per ulteriori informazioni sull'utilizzo della classe con la policy per le quote, consulta Policy per le quote. 

<Identifier name="_default">
   <Class ref="request.header.classIdentifier">
     <Allow>200</Allow>
   </Class>
</Identifier>
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

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.
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.
policies.resetquota.FailedToResolveRLPolicy 500 La variabile a cui fa riferimento l'attributo ref nell'elemento <Quota> non può essere risolta.

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.

Schemi

Argomenti correlati

Criteri per le quote