Risoluzione degli errori di reimpostazione della quota di runtime

Stai visualizzando la documentazione di Apigee e Apigee hybrid.
Visualizza la documentazione di Apigee Edge.

InvalidRLPolicy

Codice di errore

policies.resetquota.InvalidRLPolicy

Corpo della risposta di errore

{
    "fault": {
        "faultstring": "Invalid rate limit policy quota_policy_name",
        "detail": {
            "errorcode": "policies.resetquota.InvalidRLPolicy"
        }
    }
}

Esempio di messaggio di errore

{
    "fault": {
        "faultstring": "Invalid rate limit policy MyQuotaPolicy",
        "detail": {
            "errorcode": "policies.resetquota.InvalidRLPolicy"
        }
    }
}

Causa

Questo errore si verifica se il criterio per le quote specificato nell'elemento <Quota> del criterio per la reimpostazione della quota non viene definito nel proxy API. L'elemento <Quota> è obbligatorio e identifica il criterio per le quote di destinazione il cui contatore deve essere aggiornato tramite il criterio per le quote di reimpostazione. Questo criterio per le quote di destinazione deve essere creato e definito all'interno dello stesso proxy API e deve essere disponibile durante il flusso.

Ad esempio, supponiamo che l'elemento <Quota> sia definito come mostrato di seguito, ma se MyQuotaPolicy non è definito nel proxy API, viene visualizzato l'errore riportato sopra.

<Quota name="MyQuotaPolicy">

Diagnosi

  1. Identifica il nome del criterio per le quote non valido specificato nel criterio per la reimpostazione della quota. Puoi trovare il nome del criterio per le quote nella stringa di errore. Ad esempio, nella seguente stringa di errore, il nome del criterio per le quote è MyQuotaPolicy:

    "faultstring": "Invalid rate limit policy MyQuotaPolicy"
    
  2. Esamina ogni criterio di reimpostazione della quota nel proxy API in cui si è verificato l'errore. Identifica lo specifico criterio di reimpostazione delle quote in cui il criterio per le quote specificato nell'elemento obbligatorio <Quota> corrisponde al nome identificato nel passaggio 1 precedente.

    Ad esempio, il seguente criterio di Reimposta quota specifica un criterio per le quote denominato MyQuotaPolicy, che corrisponde al contenuto della stringa di errore:

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
        <ResetQuota async="false" continueOnError="false" enabled="true" name="Reset_Quota_Demo">
        <DisplayName>Reset_Quota_Demo</DisplayName>
        <Properties/>
        <Quota name="MyQuotaPolicy">
           <Identifier name="identifierName" ref="request.header.identifier">
                <Allow>100</Allow>
            </Identifier>
        </Quota>
    </ResetQuota>
    
    
  3. Determina se questo criterio per le quote è stato creato e definito all'interno dello stesso proxy API. Se il criterio per le quote non esiste all'interno dello stesso proxy API, è questa la causa dell'errore.

    Nell'esempio mostrato sopra, il criterio per le quote MyQuotaPolicy dovrebbe esistere nel flusso prima dell'esecuzione del criterio di reimpostazione della quota Reset_Quota_Demo.

    Poiché il criterio per le quote MyQuotaPolicy non esiste nel flusso, riceverai il codice di errore:

"errorcode": "policies.resetquota.InvalidRLPolicy"

Risoluzione

Assicurati che i criteri per le quote dichiarati nell'elemento <Quota> siano definiti nel proxy API. Questo criterio per le quote di destinazione deve essere disponibile quando viene eseguito il criterio per la reimpostazione della quota.

FailedToResolveAllowCountRef

Codice di errore

policies.resetquota.FailedToResolveAllowCountRef

Corpo della risposta di errore

Failed to resolve allow count reference reference_name for identifier identifier_name
in ResetQuotaStepDefinition:policy_name;API Proxy:proxy_name;Revision:
revision_number;Environment:env_name;Organization:org_name

Esempio di messaggio di errore

Failed to resolve allow count reference request.header.allowcount for identifier
identifierName in ResetQuotaStepDefinition:ResetQuota;API Proxy:Reset_Quota;
Revision:10;Environment:test;Organization:demo

Nota: il messaggio di errore riportato sopra non viene inviato come risposta al client. È visibile solo nello strumento Trace come un errore del criterio di reimpostazione della quota. Di seguito è mostrato uno screenshot di esempio.

In Proprietà, la riga di errore viene compilata con un messaggio.

L'errore restituito al client sarà semplicemente: policies.ratelimit.QuotaViolation.

Causa

Questo errore si verifica se 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 di quota.

Diagnosi

  1. Identifica il criterio di reimpostazione della quota in cui si è verificato l'errore e il nome della variabile di riferimento che non può essere risolto. Puoi trovare entrambi questi elementi nella risposta di errore.

    Ad esempio, nella seguente stringa di errore, il nome del criterio è ResetQuota e il riferimento è request.header.allowcount:

    Failed to resolve allow count reference request.header.allowcount for identifier
    identifierName in ResetQuotaStepDefinition:ResetQuota;API Proxy:Reset_Quota;
    Revision:10;Environment:test;Organization:demo
    
  2. Nel file XML del criterio di reimpostazione della quota non riuscito, verifica che il nome della variabile di riferimento utilizzata corrisponda al nome del riferimento identificato nella risposta di errore (passaggio 1 sopra).

    Ad esempio, il criterio seguente imposta l'elemento con il riferimento denominato request.header.allowcount, che corrisponde all'errore:

    <ResetQuota async="false" continueOnError="false" enabled="true" name="ResetQuota">
        <DisplayName>ResetQuota</DisplayName>
        <Properties/>
        <Quota name="MyQuotaPolicy">
            <Identifier name="identifierName">
                <Allow ref="request.header.allowcount"/>
            </Identifier>
        </Quota>
    </ResetQuota>
    
  3. Determina se la variabile di riferimento è definita e disponibile nel flusso in cui viene eseguito il criterio di reimpostazione della quota.

  4. Se la variabile è:

    1. fuori ambito (non disponibile nel flusso specifico in cui viene eseguita la norma) oppure
    2. non possono essere risolti (non è definito)

    questa è la causa dell'errore.

    Nell'esempio mostrato sopra, il valore del conteggio consentito nell'elemento <Allow> dovrebbe essere recuperato dall'intestazione della richiesta denominata allowcount. Tuttavia, Apigee non è in grado di risolvere request.header.allowcount. Questo accade se l'intestazione allowcount non viene passata nell'ambito della richiesta API.

    Di seguito è riportata una richiesta API di esempio che non passa l'intestazione allowcount come parte della richiesta:

    curl -v http://your_host_alias/v1/reset_quota -H "Content-Type: application/json"
    

    Dove your_host_alias è un dominio visibile al pubblico utilizzato per accedere alle tue API, come configurato nella proprietà virtualhosts.hostAliases nel file di override. Consulta Specificare gli override della configurazione.

    Poiché l'intestazione allowcount non viene passata come parte della richiesta, la variabile request.header.allowcount utilizzata nell'elemento <Allow> nel criterio di reimpostazione della quota precedente non è definita e pertanto non può essere risolta. Riceverai quindi la risposta di errore:

    Failed to resolve allow count reference request.header.allowcount for identifier
    identifierName in ResetQuotaStepDefinition:ResetQuota;API Proxy:Reset_Quota;
    Revision:10;Environment:test;Organization:demo
    

Risoluzione

Assicurati che la variabile a cui viene fatto riferimento nell'elemento <Allow> esista/sia definita e disponibile nel flusso specifico in cui viene eseguito il criterio di reimpostazione della quota.

Per correggere l'esempio mostrato sopra, puoi modificare la richiesta in modo da includere l'intestazione allowcount come mostrato di seguito:

curl -v http://your_host_alias/v1/reset_quota -H "Content-Type: application/json" -H "allowcount:30"

Dove your_host_alias è un dominio visibile al pubblico utilizzato per accedere alle tue API, come configurato nella proprietà virtualhosts.hostAliases nel file di override. Consulta Specificare gli override della configurazione.

FailedToResolveRLPolicy

Codice di errore

policies.resetquota.FailedToResolveRLPolicy

Corpo della risposta di errore

{
    "fault": {
        "faultstring": "Failed to resolve rate limit policy",
        "detail": {
            "errorcode": "policies.resetquota.FailedToResolveRLPolicy"
        }
    }
}

Esempio di messaggio di errore

{
    "fault": {
        "faultstring": "Failed to resolve rate limit policy",
        "detail": {
            "errorcode": "policies.resetquota.FailedToResolveRLPolicy"
        }
    }
}

Causa

Questo errore si verifica se la variabile a cui fa riferimento l'attributo ref nell'elemento <Quota> non può essere risolta.

Ad esempio, se l'attributo ref è impostato su request.header.quotapolicy nell'elemento <Quota>, ma non è disponibile nel flusso proxy API, viene visualizzato l'errore sopra riportato.

<Quota ref="request.header.quotapolicy">

Diagnosi

  1. Esamina ciascuno dei criteri di reimpostazione della quota nel proxy API in cui si è verificato l'errore e identifica il criterio di reimpostazione della quota in cui il nome della variabile di riferimento specificata nell'elemento <Quota> non può essere risolto correttamente.

  2. Determinare se la variabile è definita e disponibile nel flusso in cui viene eseguito il criterio di reimpostazione della quota.

  3. Se la variabile è:

    1. fuori ambito (non disponibile nel flusso specifico in cui viene eseguita la norma) oppure
    2. non possono essere risolti (non è definito)

    questa è la causa dell'errore.

    Nell'esempio mostrato di seguito, il nome del criterio per le quote di destinazione dovrebbe essere recuperato dall'intestazione della richiesta denominata quotapolicy. Tuttavia, Apigee non è in grado di risolvere request.header.quotapolicy. Questo accade se l'intestazione quotapolicy non viene passata come parte della richiesta API.

    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
    <ResetQuota async="false" continueOnError="false" enabled="true" name="Reset_Quota_Demo">
        <DisplayName>Reset_Quota_Demo</DisplayName>
        <Properties/>
        <Quota ref="request.header.quotapolicy">
            <Identifier name="identifierName" ref="request.header.identifier">
                <Allow>100</Allow>
            </Identifier>
        </Quota>
    </ResetQuota>
    

    Di seguito è riportata una richiesta API di esempio che non passa l'intestazione quotapolicy come parte della richiesta:

    curl -v http://your_host_alias/v1/reset_quota -H "Content-Type: application/json"
    

    Dove your_host_alias è un dominio visibile al pubblico utilizzato per accedere alle tue API, come configurato nella proprietà virtualhosts.hostAliases nel file di override. Consulta Specificare gli override della configurazione.

    Poiché l'intestazione quotapolicy non viene passata come parte della richiesta, il riferimento request.header.quotapolicy utilizzato nell'elemento <Quota> nel criterio di reimpostazione della quota precedente non è definito e non può essere risolto. Di conseguenza, ricevi la risposta di errore:

    "errorcode": "policies.resetquota.FailedToResolveRLPolicy"
    

Risoluzione

Assicurati che l'attributo ref a cui viene fatto riferimento nell'elemento <Quota> venga risolto in fase di runtime e che sia disponibile nel flusso specifico in cui viene eseguito il criterio di reimpostazione della quota.

Per correggere l'esempio mostrato sopra, puoi modificare la richiesta in modo da includere l'intestazione quotapolicy come mostrato di seguito:

curl -v http://your_host_alias/v1/reset_quota -H "Content-Type: application/json" -H "quotapolicy:MyQuotaPolicy"

Dove your_host_alias è un dominio visibile al pubblico utilizzato per accedere alle tue API, come configurato nella proprietà virtualhosts.hostAliases nel file di override. Consulta Specificare gli override della configurazione.