Questa pagina è stata tradotta dall'API Cloud Translation.

Criterio ResetQuota

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Cosa

Da utilizzare per modificare dinamicamente il numero rimanente di richieste consentite dai criteri per le quote target. In genere, questo criterio viene utilizzato per ridurre il conteggio delle quote corrente del criterio per le quote di destinazione piuttosto che attendere il ripristino del conteggio delle quote.

Ad esempio, il criterio per le quote target limita uno sviluppatore a 1000 richieste a settimana. Al secondo giorno della settimana, lo sviluppatore ha già raggiunto questo limite. Utilizza il criterio di reimpostazione della quota per sottrarre 500 dal contatore della quota in modo da 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 estensibile e il suo utilizzo potrebbe comportare 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 Tipi di criteri.

Per saperne di più sulle norme relative alle quote, consulta le norme relative alle quote. Consulta anche questo post della community sull'utilizzo del criterio 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 Reimposta quota specifica il criterio per le quote di destinazione utilizzando l'attributo name del tag <Quota>. Nell'esempio precedente, il criterio MyQuotaPolicy è il target.

Tutti i criteri di reimpostazione della quota richiedono il tag <Identifier> per specificare il contatore nel criterio di quota da aggiornare. Per impostazione predefinita, un criterio per le quote ha un singolo contatore, a meno che non includa anche il tag <Identifier>. In questo esempio, il criterio di quota di destinazione non utilizza il tag <Identifier>, pertanto specifica l'attributo name come _default.

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

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 relativo conteggio 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 per il tag <Identifier> del criterio per la reimpostazione della quota per aggiornare un conteggio delle quote specifico. Notare che il tag <Identifier> nel criterio per le quote di destinazione riportato di seguito corrisponde al valore specificato per il 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 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	Presenza
`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: Le regole di errore vengono attivate SOLO in uno stato di errore (informazioni su continueOnError) Gestione degli errori all'interno del flusso corrente	falso	Facoltativo
`enabled`	Imposta su `true` per applicare il criterio. Imposta `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	Ritirato

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

Predefinito	N/D Se ometti questo elemento, viene utilizzato il valore dell'attributo `name` del criterio.
Presenza	Facoltativo
Tipo	Stringa

N/D

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

Presenza Facoltativo

Tipo Stringa

Elemento <Quota>

Identifica il criterio di quota target di cui deve essere aggiornato il contatore.

<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 del criterio di quota di destinazione.	N/D	Facoltativo
ref	Una variabile di flusso che contiene il nome del criterio di quota di destinazione. Se sono 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>

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 nel criterio Quota di destinazione. Per un criterio di quota che non utilizza il tag <Identifier>, specifica _default.	N/D	Facoltativo
ref	Una variabile di flusso contenente il nome dell'identificatore del conteggio nel criterio di quota di destinazione. Se sono specificati sia ref che name, ref ha la priorità. Se ref non viene risolto al momento dell'esecuzione, viene utilizzato name.	N/D	Facoltativo

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

Specifica l'importo per diminuire 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>

Valore predefinito:	N/D
Presenza:	Obbligatorio
Tipo:	Numero intero

Attributi

Attributo	Descrizione	Predefinito	Presenza
ref	Una variabile di flusso che contiene la modifica del conteggio delle quote nel criterio Quota target.	N/D	Facoltativo

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

Specifica la classe per cui viene aggiornato il contatore delle quote. Per saperne di più sull'utilizzo del corso con il criterio di quota, consulta le norme relative alla quota.

<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 del flusso che contiene la classe di quota da aggiornare.	N/D	Facoltativo

Messaggi di errore

Questa sezione descrive i codici di errore e i messaggi di errore restituiti e le variabili di errore impostate da Apigee quando questo criterio attiva un errore. Queste informazioni sono importanti se stai sviluppando regole di errore per gestire gli errori. Per scoprire di più, consulta Informazioni importanti sugli errori relativi alle norme e Gestione degli errori.

Errori di runtime

Questi errori possono verificarsi durante l'esecuzione del criterio.

Codice guasto	Stato HTTP	Causa
`policies.resetquota.InvalidRLPolicy`	`500`	Il criterio `Quota` specificato nell'elemento `<Quota>` del criterio `ResetQuota` non è definito nel proxy API e quindi 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`.
`policies.resetquota.FailedToResolveAllowCountRef`	N/D	Il riferimento alla variabile contenente il conteggio delle autorizzazioni nell'elemento `<Allow>` del criterio non può essere risolto in un valore. Questo elemento è obbligatorio e specifica l'importo per diminuire il contatore della 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 dell'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.

Schemi

Argomenti correlati

Criteri per le quote