Reimposta criterio quota

Stai visualizzando la documentazione di Apigee Edge.
Vai alla documentazione di Apigee X. informazioni

Cosa

Consente di modificare in modo dinamico il numero rimanente di richieste consentite dal criterio per le quote di destinazione. In genere, questo criterio viene utilizzato per ridurre il conteggio della quota attuale del criterio per le quote di destinazione, anziché attendere la reimpostazione del conteggio della quota.

Ad esempio, il criterio per le quote target limita uno sviluppatore a 1000 richieste alla settimana. Entro il secondo giorno della settimana, lo sviluppatore ha già raggiunto questo limite. Utilizza il criterio di reimpostazione della 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.

Consulta Criteri per le quote per saperne di più sui criteri per le quote. Consulta anche questo post della scheda Community sull'utilizzo dei criteri di reimpostazione delle quote.

Samples

Questi esempi di codice dei criteri mostrano come reimpostare i contatori della quota:

Reimposta contatore predefinito

<ResetQuota name="resetQuota">
   <Quota name="MyQuotaPolicy">
      <Identifier name="_default">
         <Allow>100</Allow>
      </Identifier>
   </Quota>
</ResetQuota>

Il criterio di reimpostazione della quota specifica il criterio per le quote di destinazione utilizzando l'attributo name del tag <Quota>. Nell'esempio precedente, il criterio MyQuotaPolicy è la destinazione.

Tutti i criteri di reimpostazione delle quote richiedono che il tag <Identifier> specifichi il contatore nel criterio per le quote da aggiornare. 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, i criteri per le quote di destinazione non utilizzano il tag <Identifier>, quindi specifichi l'attributo name come _default.

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

Di seguito è riportata la definizione dei criteri per le quote 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, il nome del criterio per le quote di destinazione e la modifica al conteggio della quota vengono trasmessi come intestazioni nella richiesta. Puoi quindi fare riferimento alle variabili di flusso contenenti questi valori nel criterio di reimpostazione della 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 nel tag <Identifier> del criterio di reimpostazione della quota per aggiornare un conteggio di quota specifico. Osserva come il tag <Identifier> nel criterio per le quote di destinazione riportato di seguito corrisponde al valore specificato nel criterio per la reimpostazione della quota: 

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

Riferimento elemento

Il riferimento elemento descrive gli elementi e gli attributi del criterio di reimpostazione della 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 name può contenere lettere, numeri, spazi, trattini, trattini bassi e punti. Questo valore non può superare i 255 caratteri.

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

 N/A Obbligatorie
continueOnError

Impostalo su false per restituire un errore in caso di errore di un criterio. Questo è il comportamento previsto per la maggior parte dei criteri.

Imposta su true per fare in modo che l'esecuzione del flusso continui anche in caso di errore di un criterio.

 false Facoltativo
enabled

Imposta il criterio su true per applicare il criterio.

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

 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 name del criterio.
Presenza Facoltativo
Tipo Stringa

Elemento <Quota>

Identifica il criterio per le quote di destinazione di cui aggiornare il contatore.

<Quota name="quotaName"  ref="request.header.quotapolicy">
   <Identifier name="identifierName" ref="request.header.identifier">
      <Allow>100</Allow>
   </Identifier>
</Quota>
Predefinito: N/A
Presenza: Obbligatorie
Tipo: N/A

Attributi

Attributo Descrizione Predefinito Presenza
nome

Specifica il nome del criterio per le quote di destinazione.

N/A Facoltativo
rif Una variabile di flusso contenente il nome del criterio per le quote di destinazione. Se vengono 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 le quote target specifica il tag <Identifier>. 

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

Attributi

Attributo Descrizione Predefinito Presenza
nome

Specifica il nome dell'identificatore conteggio nei criteri per le quote di destinazione. Per un criterio per le quote che non utilizza il tag <Identifier>, specifica _default.

 N/A Facoltativo
rif

Una variabile di flusso contenente il nome dell'identificatore conteggio nel criterio per le quote di destinazione. Se vengono 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 la quantità per ridurre il contatore di 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>
Predefinito: N/A
Presenza: Obbligatorie
Tipo: Numero intero

Attributi

Attributo Descrizione Predefinito Presenza
rif

Una variabile di flusso che contiene la modifica al conteggio della quota nei criteri per le quote di destinazione.

N/A Facoltativo

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

Specifica la classe per la quale viene aggiornato il contatore quota. Per ulteriori informazioni sull'utilizzo della classe con i criteri per le quote, consulta Criteri per le quote. 

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

Attributi

Attributo Descrizione Predefinito Presenza
rif

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 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