Gestione degli errori

Questa pagina si applica a Apigee e Apigee ibridi.

Visualizza documentazione di Apigee Edge.

Quando i proxy API gestiscono le richieste delle app, possono verificarsi molte condizioni di errore. Per Ad esempio, i proxy API potrebbero riscontrare problemi di rete durante la comunicazione con i servizi di backend, le app potrebbero presentare credenziali scadute, i messaggi di richiesta potrebbero essere formattati in modo errato e così via attiva.

Quando si verifica un errore dopo che un'app client chiama un proxy API, viene restituito un messaggio di errore a il cliente. Per impostazione predefinita, il client riceve un messaggio di errore spesso criptico senza dettagli o indicazioni. Tuttavia, se vuoi sostituire i messaggi di errore predefiniti con messaggi personalizzati più utili e e persino arricchirli con intestazioni HTTP aggiuntive, in Apigee.

La gestione degli errori personalizzata ti consente anche di aggiungere funzionalità come la registrazione dei messaggi ogni volta che si verifica un errore.

Prima di parlare dell'implementazione della gestione personalizzata degli errori nei proxy API, è utile: capire come si verificano gli errori e come i proxy API reagiscono ad essi.

Video

Guarda i seguenti video per scoprire di più sulla gestione degli errori.

Video Descrizione
Introduzione alla gestione degli errori e ai flussi di errori Scopri di più sulla gestione degli errori e su cosa succede quando si verifica un errore in un proxy API.
Gestire gli errori utilizzando le regole di errore Scopri come gestire gli errori utilizzando le regole di errore.
Generare errori personalizzati utilizzando il criterio RaiseFault Genera errori personalizzati durante il runtime dell'API utilizzando il criterio RaiseFault.
Definire le regole di errore nei proxy API e negli endpoint di destinazione Definire le regole di errore nel proxy API e negli endpoint di destinazione e comprendere il le differenze.
Informazioni sull'ordine di esecuzione delle regole di errore Comprendi l'ordine di esecuzione delle regole di errore nel proxy API e nella destinazione endpoint.
Definisci valore predefinito regola di errore Definisci una regola di errore predefinita per gestire errori generici nell'API.

Come si verificano gli errori

Per prima cosa, spiegheremo semplicemente come si verificano gli errori. Sapere come si verificano gli errori ti aiuta a pianificare per le diverse situazioni in cui vuoi implementare una gestione personalizzata degli errori.

Errori automatici

Un proxy API genera automaticamente un errore nelle seguenti situazioni:

  • Un criterio genera un errore. Ad esempio, se una chiamata API invia una chiave scaduta, Il criterio VerifyAPIKey genera automaticamente un errore; o se il numero di chiamate API supera un determinato limite, il criterio per le quote o il criterio SpikeArrest genera un errore. (consulta la Guida di riferimento agli errori di criteri per tipi di errori che possono essere generati dai criteri).
  • Si è verificato un problema nel flusso dei messaggi proxy API, ad esempio un errore di routing.
  • Si è verificato un errore del backend, ad esempio un errore HTTP dovuto a errori a livello di protocollo, TLS/SSL o un servizio di destinazione non disponibile.
  • Si è verificato un errore a livello di sistema, ad esempio un'eccezione di memoria insufficiente.

Per ulteriori informazioni su questi errori, consulta la Tassonomia degli errori in questo argomento.

Errori personalizzati

Per le situazioni in cui non è presente un errore automatico, ti consigliamo di generare un errore personalizzato, ad esempio se una risposta contiene la parola unavailable o se il codice di stato HTTP è maggiore di 201. Per farlo, aggiungi un criterio RaiseFault alla sezione posto appropriato in un flusso di proxy API.

Puoi aggiungere un criterio RaiseFault a un flusso proxy API come faresti con qualsiasi altro criterio. Nella nel seguente esempio di configurazione proxy, il criterio Raise-Fault-1 è associato la risposta TargetEndpoint. Se la parola unavailable è presente nella risposta del servizio di destinazione, il criterio RaiseFault viene eseguito e genera un errore.

<TargetEndpoint name="default">
...
  <Response>
    <Step>
      <Name>Raise-Fault-1</Name>
      <Condition>message.content Like "*unavailable*"</Condition>
    </Step>
  </Response>

Hai solo l'obiettivo di mostrarti che puoi generare errori personalizzati. Forniamo maggiori dettagli sul criterio RaiseFault nella sezione FaultRules e il criterio RaiseFault.

Per altri esempi, consulta questi post della community di Apigee:

Comportamento dei proxy API quando si verificano errori

Ecco cosa succede quando un proxy restituisce un errore.

Esci dalla pipeline proxy

Quando un proxy API rileva un errore, indipendentemente da come si verifica, esce dalla pipeline di flusso normale, entra uno stato di errore e restituisce un messaggio di errore all'app client. Una volta che il proxy API entra nella non può tornare all'elaborazione nella normale pipeline di flusso.

Ad esempio, supponiamo che un proxy API abbia i criteri nel seguente ordine nella richiesta ProxyEndpoint:

  1. Verifica chiave API
  2. Quota
  3. Da JSON a XML

Se si verifica un errore durante la verifica della chiave API, il proxy API passa allo stato di errore. La I criteri per le quote e da JSON a XML non vengono eseguiti, il proxy non procede al TargetEndpoint e viene restituito un messaggio di errore all'app client.

Controlla FaultRules

Nello stato di errore, i proxy API controllano anche la presenza di quanto segue (in ordine) nella configurazione del proxy API prima di restituire un messaggio di errore predefinito all'app client:

  1. Una sezione <FaultRules>, che contiene la logica per attivare messaggi di errore personalizzati (e altri criteri) in base a condizioni specifiche che definire.
  2. Una sezione <DefaultFaultRule>, che attiva un valore predefinito nelle seguenti situazioni:
    • Nessun <FaultRules> definito.
    • Nessun <FaultRules> esistente viene eseguito.
    • L'elemento <AlwaysEnforce> è impostato su true.

In sostanza, il proxy API ti dà la possibilità di restituire un messaggio di errore personalizzato e attivare un'altra logica. Se il proxy non trova nessuna di queste sezioni o se esistono, ma non sono un errore, il proxy invia il proprio messaggio predefinito generato da Apigee.

Esempio di gestione degli errori semplice

Iniziamo con un esempio semplice, in cui una chiamata a un proxy API non contiene una chiave API obbligatoria. Per impostazione predefinita, la risposta restituita all'app client è la seguente:

HTTP/1.1 401 Unauthorized
Date: Wed, 20 Jul 2016 19:19:32 GMT
Content-Type: application/json
Content-Length: 150
Connection: keep-alive
Server: Apigee Router

* Connection #0 to host myorg-test.apigee.net left intact
{"fault":{"faultstring":"Failed to resolve API Key variable request.queryparam.apikey","detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}

Gli utenti dell'API potrebbero essere in grado di capire il messaggio di errore, ma non è detto. E molti modelli predefiniti gli errori sono più sottili e più difficili da decifrare.

In qualità di sviluppatore di API, sta a te modificare questo messaggio per soddisfare le esigenze di chi lo riceverà, che si tratti di uno sviluppatore di app per iOS o di un gruppo di test interno con requisiti di formato dei messaggi di errore propri.

Ecco un esempio base di come creare un messaggio di errore personalizzato per gestire questo errore. Questo richiede 1) un criterio che definisce il messaggio personalizzato e 2) una regola di errore che esegua il criterio quando il proxy entra in stato di errore.

1. Crea un criterio che definisce il messaggio personalizzato,

Innanzitutto, crea un criterio che definisce il messaggio di errore personalizzato. Puoi usare qualsiasi tipo di criterio, come un criterioAssignMessage, che consente di impostare un payload e intestazioni HTTP facoltative come codice di stato e una frase del motivo. Il criterioAssignMessage è l'ideale. Permette di controllare il payload dei messaggi, un codice di stato HTTP diverso, impostare una frase di motivo HTTP diversa e aggiungere intestazioni HTTP.

Non è necessario collegare il criterio a un flusso: come descritto in Crea il criterio.

Di seguito è riportato un esempio di criterio AssignMessage che:

  • Restituisce un messaggio JSON.
  • Imposta un codice di stato HTTP (911, che è un evidente codice di stato inesistente semplicemente per per illustrare la tua flessibilità). Il codice di stato viene visualizzato nell'intestazione HTTP.
  • Consente di impostare una frase di motivi HTTP per sostituire la frase predefinita del motivo Unauthorized per questo errore chiave API mancante). La frase del motivo viene visualizzata accanto al codice di stato nell'intestazione HTTP.
  • Crea e compila una nuova intestazione HTTP denominata invalidKey.
<AssignMessage async="false" continueOnError="false" enabled="true" name="invalid-key-message">
    <DisplayName>Invalid key message</DisplayName>
    <Set>
        <Payload contentType="application/json">{"Citizen":"Where's your API key? I don't see it as a query parameter"}</Payload>
        <StatusCode>911</StatusCode>
    </Set>
    <Add>
        <Headers>
            <Header name="invalidKey">Invalid API key! Call the cops!</Header>
        </Headers>
    </Add>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
    <AssignTo createNew="false" transport="http" type="request"/>
</AssignMessage>

Quando questo criterio viene eseguito, la risposta all'app client sarà la seguente. Confrontala con la risposta predefinita mostrata in precedenza.

HTTP/1.1 911 Rejected by API Key Emergency Services
Date: Wed, 20 Jul 2016 18:42:36 GMT
Content-Type: application/json
Content-Length: 35
Connection: keep-alive
invalidKey: Invalid API key! Call the cops!
Server: Apigee Router

* Connection #0 to host myorg-test.apigee.net left intact
{"Citizen":"Where's your API key? I don't see it as a query parameter."}

Sì, è un po' sciocco, ma ti mostra le possibilità. Almeno ora lo sviluppatore quando ricevono il messaggio sa di aver dimenticato di includere una chiave API come parametro di query.

Come viene applicata questa norma? Viene mostrata la sezione successiva.

2. Crea il &lt;FaultRule&gt; che attiverà il criterio

Nelle sezioni <ProxyEndpoint> o <TargetEndpoint> della configurazione del proxy, aggiungi un blocco XML <FaultRules> contenente una o più sezioni <FaultRule>. Ogni FaultRule rappresenta un errore diverso che vuoi gestire. In questo semplice esempio, utilizzeremo un solo FaultRule per mostrarti di che cosa è composto.

Devi anche aggiungere un <DefaultFaultRule> per fornire un messaggio di errore generale personalizzato se nessuno dei tuoi FaultRule viene eseguito.

Esempio

<ProxyEndpoint name="default">
...
    <FaultRules>
       <FaultRule name="invalid_key_rule">
            <Step>
                <Name>invalid-key-message</Name>
            </Step>
            <Condition>(fault.name = "FailedToResolveAPIKey")</Condition>
        </FaultRule>
    </FaultRules>
    <DefaultFaultRule name="default-fault">
        <Step>
            <Name>Default-message</Name>
        </Step>
    </DefaultFaultRule>

Punti chiave:

  • Le FaultRules sono definite nel ProxyEndpoint. Questo è importante. Maggiori informazioni su come inserire FaultRules in ProxyEndpoint rispetto a TargetEndpoint più avanti.
  • <Name>: il nome del criterio da eseguire. Il nome proviene dall'attributo name del criterio nell'elemento principale, come mostrato nell'esempio di criterio precedente.

  • <Condition>: Apigee valuta la condizione ed esegue il criterio solo se la condizione è vera. Se sono presenti più FaultRule che valutano true, Apigee esegue il primo che è true. Importante: il L'ordine di valutazione delle regole di errore (dall'alto verso il basso o dal basso verso l'alto) varia TargetEndpoint e ProxyEndpoint, come descritto nella sezione FaultRules e logica di esecuzione. Se non includi una condizione, la regola di errore è automaticamente vera. Tuttavia, non si tratta di una best practice. Ogni regola FaultRule deve avere la propria .

  • <DefaultFaultRule>: se nessuna regola di errore personalizzata è eseguito, l'operazione <DefaultFaultRule> viene eseguita, inviando una query personalizzato invece del messaggio criptico predefinito generato da Apigee. R <DefaultFaultRule> può anche avere un <Condition>, ma in nella maggior parte dei casi non ne includerai uno perché vuoi che venga eseguito, a prescindere dall'ultima resort.

    La regola DefaultFaultRule viene in genere utilizzata per restituire un messaggio di errore generico per qualsiasi errore imprevisto. Un esempio è un messaggio che contiene i dati di contatto per l'assistenza tecnica. Questa risposta predefinita ha il duplice scopo di fornire informazioni ottimizzate per gli sviluppatori e offuscando al contempo gli URL di backend o altre informazioni essere utilizzati per compromettere il sistema.

Più regole di errore e logica di esecuzione

Nella sezione Esempio di gestione degli errori semplici, abbiamo utilizzato un semplice esempio di una singola regola di errore e condizione. In un progetto API reale, con tutti i possibili errori che possono verificarsi, è probabile che tu abbia più FaultRule e un DefaultFaultRule sia in <ProxyEndpoint> che in <TargetEndpoint>. In definitiva, però, Viene eseguita una sola FaultRule quando un proxy API passa in stato di errore.

Questa sezione descrive la logica utilizzata da Apigee per gestire i FaultRule, da come arriva a un singolo FaultRule da eseguire a come vengono gestite le condizioni del passaggio interne quando viene attivato il relativo FaultRule. Questa sezione fornisce inoltre indicazioni su quando definire FaultRules nel <ProxyEndpoint> a confronto con <TargetEndpoint> e descrive il relazione tra FaultRules e il criterio RaiseFault.

Esecuzione di FaultRules

In breve, ecco la logica utilizzata da Apigee quando un proxy API passa in stato di errore. Tieni presente che esiste una leggera differenza tra la valutazione di FaultRules in ProxyEndpoint e in TargetEndpoint.

  1. Apigee valuta le FaultRules nel ProxyEndpoint o nel TargetEndpoint, a seconda in cui si è verificato l'errore:
    • ProxyEndpoint: Apigee inizia con il <FaultRule> inferiore nel file XML di configurazione e procede verso l'alto, valutando il <Condition> di ogni <FaultRule> (la condizione esterna, non le condizioni <Step> interne).
    • TargetEndpoint: Apigee inizia con il <FaultRule> principale nel file XML di configurazione e procede verso il basso, valutando il <Condition> di ogni <FaultRule> (la condizione esterna, non le condizioni <Step> interne).
  2. Esegue la prima regola di errore la cui condizione è vera. Se una regola di errore non ha condizioni, è vera per impostazione predefinita.
    • Quando viene eseguita una regola di errore, tutti i passaggi all'interno di quest'ultima vengono valutati in ordine. dall'alto verso il basso nella configurazione XML. I passaggi senza condizioni vengono eseguiti automaticamente (vengono eseguiti i criteri) e i passaggi con un <Condition> che valuta vengono eseguiti (le condizioni che valutano <Condition> non vengono eseguite).

    • Se viene eseguita una regola Fault, ma non viene eseguito nessun passaggio in quest'ultima (perché vengono valutate come code), il messaggio di errore predefinito generato da Apigee viene restituito l'app client. <DefaultFaultRule> non viene eseguito, perché Apigee ha già eseguito la sua unica regola Fault.

  3. Se non viene eseguita alcuna regola di errore, Apigee esegue <DefaultFaultRule>, se presente.

Di seguito sono riportati alcuni esempi con commenti in linea.

Esecuzione proxyEndpoint

La valutazione dei FaultRule di ProxyEndpoint avviene dal basso verso l'alto, quindi inizia a leggere dall'ultimo FaultRule nel seguente esempio e procedi verso l'alto. Esamina per ultimo DefaultFaultRule.

<ProxyEndpoint name="default">
...
    <FaultRules>
<!-- 3. This FaultRule is automatically TRUE, because there's no outer
     condition. But because the FaultRule just below this got
     executed (bottom-to-top evaluation in a ProxyEndpoint), Apigee
     doesn't even evaluate this FaultRule.
     Note that it's not a best practice to have a FaultRule without 
     an outer condition, which automatically makes the FaultRule true. -->
        <FaultRule name="random-error-message">
            <Step>
                <Name>Random-fault</Name>
            </Step>
        </FaultRule>
<!-- 2. Let's say this fault is TRUE. The Quota policy threw a QuotaViolation
     error. This is the first FaultRule to be TRUE, so it's executed. 
     Now the Steps are evaluated, and for the ones whose conditions
     evaluate to TRUE, their policies are executed. Steps without
     conditions are automatically true. -->
<FaultRule name="over_quota">
            <Step>
                <Name>developer-over-quota-fault</Name>
                <Condition>(ratelimit.developer-quota-policy.exceed.count GreaterThan "0")</Condition>
            </Step>
            <Step>
                <Name>global-over-quota-fault</Name>
                <Condition>(ratelimit.global-quota-policy.exceed.count GreaterThan "0")</Condition>
            </Step>
            <Step>
                <Name>log-error-message</Name>
            </Step>
            <Condition>(fault.name = "QuotaViolation")</Condition>
        </FaultRule>
<!-- 1. Because this is the ProxyEndpoint, Apigee looks at this FaultRule
     first. But let's say this FaultRule is FALSE. A policy did not 
     throw a FailedToResolveAPIKey error. Apigee moves UP to check
     the next FaultRule. -->
        <FaultRule name="invalid_key_rule">
            <Step>
                <Name>invalid-key-message</Name>
            </Step>
            <Condition>(fault.name = "FailedToResolveAPIKey")</Condition>
        </FaultRule>
    </FaultRules>

<!-- If no <FaultRule> is executed, the <DefaultFaultRule> is executed. 
     If a FaultRule is executed, but none of its Steps are executed,
     The DefaultFaultRule is not executed (because Apigee has already
     executed its one FaultRule). -->
    <DefaultFaultRule name="default-fault">
        <Step>
            <Name>Default-message</Name>
        </Step>
    </DefaultFaultRule>

Esecuzione di TargetEndpoint

La valutazione delle regole di errore del punto di destinazione è dall'alto verso il basso, quindi inizia a leggere FaultRule nell'esempio seguente e procedi verso il basso. Esamina per ultimo DefaultFaultRule.

<TargetEndpoint name="default">
...
    <FaultRules>
<!-- 1. Because this is the TargetEndpoint, Apigee looks at this FaultRule
     first. Let's say this FaultRule is FALSE. 
     A policy did not throw a FailedToResolveAPIKey error. 
     Apigee moves down to the next FaultRule. -->
        <FaultRule name="invalid_key_rule">
            <Step>
                <Name>invalid-key-message</Name>
            </Step>
            <Condition>(fault.name = "FailedToResolveAPIKey")</Condition>
        </FaultRule>
<!-- 2. Let's say this fault is TRUE. The Quota policy threw a QuotaViolation
     error. This is the first FaultRule to be TRUE, so it's executed. 
     Now the Steps are evaluated, and for the ones whose conditions
     evaluate to TRUE, their policies are executed. Steps without
     conditions are automatically true. -->
        <FaultRule name="over_quota">
            <Step>
                <Name>developer-over-quota-fault</Name>
                <Condition>(ratelimit.developer-quota-policy.exceed.count GreaterThan "0")</Condition>
            </Step>
            <Step>
                <Name>global-over-quota-fault</Name>
                <Condition>(ratelimit.global-quota-policy.exceed.count GreaterThan "0")</Condition>
            </Step>
            <Step>
                <Name>log-error-message</Name>
            </Step>
            <Condition>(fault.name = "QuotaViolation")</Condition>
        </FaultRule>
<!-- 3. This FaultRule is automatically TRUE, because there's no outer
     condition. But because the FaultRule just above this got
     executed (top-to-bottom evaluation in a TargetEndpoint), Apigee
     doesn't even evaluate this FaultRule.
     Note that it's not a best practice to have a FaultRule without 
     an outer condition, which automatically makes the FaultRule true. -->
        <FaultRule name="random-error-message">
            <Step>
                <Name>Random-fault</Name>
            </Step>
        </FaultRule>
    </FaultRules>

<!-- If no <FaultRule> is executed, the <DefaultFaultRule> is executed. 
     If a FaultRule is executed, but none of its Steps are executed,
     The DefaultFaultRule is not executed (because Apigee has already
     executed its one FaultRule). -->
    <DefaultFaultRule name="default-fault">
        <Step>
            <Name>Default-message</Name>
        </Step>
    </DefaultFaultRule>

Ordine delle regole di errore

Come puoi vedere nell'esempio precedente, l'ordine in cui vengono inserite le regole di errore è sono importanti a seconda che l'errore si verifichi nel ProxyEndpoint o meno Endpoint di destinazione.

Ad esempio:

Ordine ProxyEndpoint Ordine endpoint di destinazione

Nell'esempio seguente, poiché la valutazione è dal basso verso l'alto, viene eseguita FaultRule 3, il che significa che FaultRules 2 e 1 non vengono valutate.

5. FaultRule 1: FALSE

4. FaultRule 2: TRUE

3. Regola errore 3: TRUE

2. FaultRule 4: FALSE

1. FaultRule 5: FALSE

Nell'esempio seguente, poiché la valutazione avviene dall'alto verso il basso, viene eseguita la regola di errore 2, il che significa che le regole di errore 3, 4 e 5 non vengono valutate.

1. FaultRule 1: FALSE

2. Regola di errore 2: TRUE

3. FaultRule 3: TRUE

4. FaultRule 4: FALSE

5. FaultRule 5: FALSE

Norme da includere

Puoi eseguire qualsiasi criterio da una regola di errore inserendoli in Passaggi. Ad esempio, puoi eseguire un criterio Assegna messaggio per formattare una risposta all'app client, quindi registrare un messaggio con il criterio di registrazione dei messaggi. I criteri vengono eseguiti nell'ordine in cui li inserisci (dall'alto verso il basso nel file XML).

Le regole di errore vengono attivate SOLO in uno stato di errore (informazioni su continueOnError)

Potrebbe sembrare che il titolo si ripeta, ma c'è una sfumatura particolare a conoscenza di un errore del proxy che causa l'ingresso in uno stato di errore di un proxy API; oppure non inserire uno stato di errore: l'attributo continueOnError su un .

Ricapitolando: un proxy API valuta <FaultRules> e <DefaultFaultRule> solo se il proxy è in uno stato di errore. Ciò significa che anche se una condizione FaultRule restituisce true, non verrà attivata se il proxy non è in uno stato di errore.

Tuttavia, ecco un esempio di errore che si verifica e il proxy non entra in uno stato di errore. In qualsiasi criterio, puoi impostare un attributo sull'elemento principale denominato continueOnError. Questo attributo è molto importante per quanto riguarda la gestione dei guasti, in quanto determina se il proxy entra in uno stato di errore se il criterio ha esito negativo. Nella maggior parte dei casi è consigliabile mantenere predefinita continueOnError="false", che visualizza il proxy in uno stato di errore se non riesce e viene attivata la gestione personalizzata degli errori. Tuttavia, se continueOnError="true" (ad esempio, se non vuoi che l'errore di un servizio callout per interrompere l'esecuzione del proxy), il proxy non entra in uno stato di errore se il criterio non riesce e il proxy non esaminerà le FaultRules.

Per informazioni sugli errori di logging quando continueOnError="true", consulta Gestione degli errori dei criteri nel flusso attuale.

Dove per definire FaultRules: ProxyEndpoint o TargetEndpoint

Quando si verifica un errore in un proxy API, l'errore si verifica in <ProxyEndpoint> (richiesta dall'app client o risposta all'app client) o in <TargetEndpoint> (richiesta al servizio target o risposta dal servizio target). Apigee cerca FaultRules ovunque si verifichi l'errore.

Ad esempio, se non è disponibile un server di destinazione (codice di stato HTTP 503), il proxy API passa in uno stato di errore nella risposta <TargetEndpoint> e il normale proxy API il flusso non continuerà verso <ProxyEndpoint>. Se hai definito FaultRules solo nell'<ProxyEndpoint>, non gestiranno l'errore.

Ecco un altro esempio. Se un criterio RaiseFault sulla <ProxyEndpoint> attiva un errore, una regola di errore in <TargetEndpoint> non riceverà eseguito.

FaultRules e il criterio RaiseFault

In apparenza le regole di errore e il criterio RaiseFault potrebbero sembrare modi alternativi per eseguire la gestione degli errori; e in qualche modo è vero. ma interagiscono anche tra di loro. Questa sezione spiega il rapporto tra i due. La comprensione di questa relazione dovrebbe aiutare devi progettare la gestione dei guasti, soprattutto se vuoi utilizzare entrambi.

In breve:

  • Le regole di errore vengono sempre valutate quando un proxy API entra in uno stato di errore.

  • Il criterio RaiseFault è un modo per impostare un proxy API in uno stato di errore quando altrimenti non si sarebbe verificato un errore.

    Ad esempio, se vuoi generare un errore se il codice di stato HTTP nella risposta da Se il servizio di destinazione è maggiore di 200, aggiungi un criterio RaiseFault nella risposta flusso di lavoro. L'aspetto sarà simile al seguente:

    <TargetEndpoint name="default">
    <PreFlow name="PreFlow">
...
        <Response>
            <Step>
                <Name>Raise-Fault-1</Name>
<!-- If the condition is true, the Raise-Fault-1 policy gets executed -->
                <Condition>(response.status.code GreaterThan "200")</Condition>
            </Step>
        </Response>

    Il criterio RaiseFault invia anche un messaggio di errore all'app client.

Cosa succede quando un criterio RaiseFault attiva un errore, che causa un errore nel proxy che esegue potenzialmente una regola di errore? È qui che le cose possono diventare un po' complicate. Se il criterio RaiseFault restituisce un messaggio di errore e viene attivata una regola FaultRule, restituisce un messaggio di errore: che cosa viene restituito all'app client?

  • Poiché la regola FaultRule o DefaultFaultRule viene eseguita dopo il criterio RaiseFault, I dati di risposta FaultRule vince.
  • I dati di risposta del criterio RaiseFault (codice di stato, frase del motivo o payload del messaggio) vengono utilizzati se non sono impostati da FaultRule o DefaultFaultRule.
  • Se sia il criterio RaiseFault che FaultRule aggiungono intestazioni HTTP personalizzate, entrambi sono inclusi nel la risposta. I nomi delle intestazioni duplicati creano un'intestazione con più valori.

Ecco un esempio di quanto impostato da un criterio RaiseFault e da una FaultRule, e cosa viene tornare all'app client. Gli esempi sono pensati per brevità, non per best practice.

Che cosa viene impostato da un criterio RaiseFault e da una regola di errore.

L'app cliente riceve:

Status Code: 468
Reason Phrase: Something happened
Payload: {"Whoa":"Sorry."}
Header:
  errorNote: woops,gremlins

<- Il criterio delle regole di errore imposta questo valore:

Status Code: [none] 
Reason Phrase: Something happened
Payload: {"Whoa":"Sorry."}
Header:
  errorNote: gremlins

<- Il criterio RaiseFault imposta questo:

Status Code: 468
Reason Phrase: Can't do that
Payload: {"DOH!":"Try again."}
Header: 
  errorNote: woops

Condizioni dell'edificio

Le condizioni sono la chiave per l'esecuzione di FaultRule. Puoi creare le condizioni FaultRule nello stesso modo che puoi fare per altre condizioni in Apigee, come i flussi condizionali o le condizioni RaiseFault.

Per contestualizzare il resto della sezione, ecco un esempio di regola di errore con un parametro Condizione FaultRule e una condizione Step interna.

<FaultRule name="invalid_key_rule">
    <Step>
        <Name>invalid-key-message</Name>
        <Condition>oauthV2.Verify-API-Key-1.failed = true</Condition>
    </Step>
    <Condition>fault.name = "FailedToResolveAPIKey"</Condition>
</FaultRule>

Variabili specifiche per gli errori dei criteri

Le variabili fault.name e {policy_namespace}.{policy_name}.failed sono disponibili quando un criterio genera un errore.

fault.name

Quando un criterio non funziona, rileva l'errore in una condizione utilizzando fault.name . Ad esempio:

<Condition>fault.name = "policy_error_name"</Condition>

Il nome dell'errore viene visualizzato nel messaggio di errore predefinito. Ad esempio, nel seguente, il nome del guasto è FailedToResolveAPIKey. In questo caso, una variabile di flusso chiamata fault.name è impostata sul valore FailedToResolveAPIKey.

{"fault":{"faultstring":"Failed to resolve API Key variable request.queryparam.apikey","detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}

La condizione sarà quindi la seguente:

<Condition>fault.name = "FailedToResolveAPIKey"</Condition>

Per un elenco degli errori dei criteri, consulta la Guida di riferimento agli errori dei criteri.

{policy_namespace}.{policy_name}.failed

La variabile *.failed è disponibile quando un criterio non va a buon fine. Di seguito sono esempi di variabili *.failed per criteri diversi. Per gli spazi dei nomi dei criteri, consulta le variabili di flusso in ciascun argomento Riferimento ai criteri.

Altre variabili disponibili

Quando un proxy API passa in stato di errore, le uniche variabili disponibili per l'utilizzo in condizioni sono:

  • Le variabili del criterio che non sono riuscite.
  • Le variabili del messaggio HTTP esistenti al momento dell'errore. Ad esempio, se un errore viene generata nella risposta, una regola di errore in <TargetEndpoint> potrebbe utilizzare HTTP dati response.status.code, message.content, error.content e così via. In alternativa, se un criterio di quota non è andato a buon fine, puoi utilizzare la variabile ratelimit.{quota_policy_name}.exceed.count. Utilizza lo strumento di debug e il riferimento alle norme per capire quali variabili e dati HTTP sono disponibili.

Ulteriori informazioni

Best practice per la gestione dei guasti

La gestione degli errori è un'importante attività di progettazione dell'architettura per lo sviluppo di proxy API. È importante prendersi il tempo di capire come e quando gestire gli errori, stabilire il contenuto dei messaggi di errore e progettarne i formati. Dopo aver capito (o come) le cose, utilizza queste best practice come ausilio per l'implementazione della gestione dei guasti.

Di seguito sono riportate alcune best practice per la progettazione e la gestione dei guasti:

  • In FaultRules, puoi specificare qualsiasi tipo di criterio. Il pattern più comune è utilizzare il criterio AssignMessage per impostare elementi specifici nella risposta di errore in attesa. Puoi anche utilizzareAssignMessage per impostare variabili da usare per altri scopi, ad esempio per le variabili a cui viene fatto riferimento dai criteri di logging eseguiti in PostClientFlow o in FlowHooks. Valuta anche la possibilità di registrare un messaggio, ad esempio con il criterio di logging dei messaggi o il criterio di callout del servizio, se vuoi registrare errori specifici in condizioni di errore specifiche.
  • Non specificare i criteri RaiseFault come passi all'interno di una regola Fault. È preferibile utilizzare i criteri AssignMessage per impostare o modificare gli elementi del messaggio, inclusi il payload, le intestazioni o il codice di stato.
  • Per ogni regola di errore o per tutte tranne l'ultima regola di errore valutata, fornisci un <Condition> esterno allegato come elemento secondario di Elemento <FaultRule>. La condizione di esecuzione di una regola di errore senza esplicita Condizione specificata, verrà valutata implicitamente come true. Un elemento <Condition> collegato come elemento secondario di un elemento <Step> non viene utilizzato per determinare se la condizione di esecuzione per la regola di errore restituisce true o false. Le condizioni del passaggio vengono valutate solo dopo che Apigee esegue la regola di errore che le contiene. In una regola di errore, è comune avere più passaggi con criteri AssignMessage (o altri), ciascuno con una condizione di passaggio.

  • Per gestire gli errori in più criteri dello stesso tipo (ad esempio, più criteri di quota), crea una regola di errore per ogni errore del criterio che potresti ricevere e poi distingui gli errori separati con le condizioni associate ai passaggi. Ad esempio: creare una FaultRule per gestire un errore nei criteri per le quote, QuotaViolation e una regola di errore separata per InvalidApiKey. (Consulta la documentazione di riferimento sugli errori di criterio per degli errori delle norme. Man mano che scopri altri errori che devono essere gestiti, puoi tornare in un secondo momento e aggiungerle a FaultRules. È consentito un approccio iterativo, anche se richiede il ricollocamento del proxy. In questo modo è possibile individuare lo stesso tipo di errore indipendentemente che genera il risultato, rendendo il tuo XML FaultRules efficiente.

    Le condizioni del passaggio interno ti offrono un controllo più granulare. Ad esempio: se applichi sia la quota per sviluppatori individuali sia quella globale con due criteri in il flusso della richiesta, imposta la condizione FaultRule outer per attivarla QuotaViolation (che viene generato quando la quota supera in entrambi i casi). Poi imposta le condizioni del passaggio per valutare le variabili exceed.count specifiche in entrambi i criteri di quota. Al client viene inviato solo l'errore pertinente (superamento della quota dello sviluppatore o superamento della quota globale). Ecco un esempio di questa configurazione:

    <FaultRule name="over_quota">
  <!-- This condition catches a QuotaViolation in *any* Quota policy -->
  <Condition>fault.name = "QuotaViolation"</Condition>
  <Step>
    <Name>AM-developer-over-quota-fault</Name>
    <Condition>ratelimit.developer-quota-policy.exceed.count GreaterThan 0</Condition>
  </Step>
  <Step>
    <Name>AM-global-over-quota-fault</Name>
    <Condition>ratelimit.global-quota-policy.exceed.count GreaterThan 0</Condition>
  </Step>
</FaultRule>

    Per un altro esempio, consulta questa discussione sulla gestione degli errori relativi ai criteri.

  • Per gestire gli errori quando utilizzi un singolo criterio di un solo tipo, considera un singolo errore che viene eseguita quando quel criterio ha esito negativo e includono più passaggi che ogni possibile errore. In questo modo, il codice XML rimane più semplice utilizzando un singolo FaultRule anziché più FaultRule (uno per ogni tipo di errore). Ad esempio, puoi specificare che le diverse I passaggi del criterio AssignMessage vengono eseguiti in condizioni diverse, ad esempio:

    <FaultRule name="raise-fault-3">
  <!-- This condition catches *any* error in the Verify-API-Key-1 policy. -->
  <Condition>oauthV2.Verify-API-Key-1.failed = "true"</Condition>
  <!-- This first step always executes, which handles errors you haven't mapped with inner conditions. -->
  <Step>
    <Name>AM-Generic-Key-Fault</Name>
  </Step>
  <Step>
    <Name>AM-API-Key-NotFound</Name>
    <Condition>fault.name = "FailedToResolveAPIKey"</Condition>
  </Step>
  <Step>
    <Name>AM-API-Key-Invalid</Name>
    <Condition>fault.name = "InvalidApiKey"</Condition>
  </Step>
</FaultRule>
  • Aggiungi FaultRules dove si verificheranno gli errori (lato client <ProxyEndpoint> o lato target <TargetEndpoint>). Includi FaultRules per ogni criterio visualizzato in ogni posizione.
  • Quando utilizzi i criteri RaiseFault insieme a FaultRules, coordina la risposta che vengono restituiti quando sia il criterio RaiseFault che una FaultRule restituiscono dati. Ad esempio, se hai un criterio RaiseFault che imposta il codice di stato HTTP, non configurare anche un passaggio AssignMessage all'interno di un criterio FaultRule che reimposta il codice di stato. Il peggio che può accadere è che il codice di stato predefinito venga restituito dell'app client.

  • L'elemento <DefaultFaultRule> completa l'elemento <FaultRules> per darti maggiore controllo sui criteri eseguiti dal proxy quando gestisce un di errore. Se specifichi un valore <DefaultFaultRule>, questo verrà eseguito se o entrambe le seguenti condizioni sono vere:

    • Nessun'altra regola di errore è stata eseguita. Un caso speciale è se c'è nessun elemento <FaultRules> configurato.
    • Se l'elemento secondario <AlwaysEnforce> di <DefaultFaultRule> è true.

    Puoi anche specificare un elemento <Condition> su un <DefaultFaultRule>. Potresti voler procedere in questo modo per escluderne l'esecuzione in base a uno stato della richiesta o a un errore in attesa ad esempio se un'intestazione specifica è presente o mancante.

    Utilizza un <DefaultFaultRule> con <AlwaysEnforce> impostato su true se hai uno o più criteri che vuoi che il proxy esegua sempre, indipendentemente dall'esecuzione di una regola FaultRule precedente. Uno possibile supponiamo che tu voglia inserire un'intestazione nella risposta in tutti i casi, indipendentemente dal fatto che la richiesta proxy abbia generato o meno un errore, e indipendentemente dal fatto che l'errore sia stato gestito o meno in precedenza. Poi per collegare un criterioAssignMessage appropriato nel Sezione <PostFlow>/<Response> e allega anche lo stesso criterio in <DefaultFaultRule> con <AlwaysEnforce> impostato su true.

Pattern per la gestione degli errori centralizzata e riutilizzabile

Un per i proxy Apigee, che descrive un pattern per la gestione centralizzata degli errori senza duplicazione del codice.

Creazione di FaultRules

Per aggiungere una regola di errore, devi modificare la configurazione XML di ProxyEndpoint o TargetEndpoint. Puoi utilizzare l'UI di Apigee per apportare questa modifica nel riquadro Codice del Sviluppa la vista per un proxy API o modifica il file XML che definisce il ProxyEndpoint o Endpoint di destinazione.

Se crei FaultRule nell'interfaccia utente di Apigee, crea prima i criteri da eseguire, poi aggiungili alla configurazione di FaultRule. (riceverai un errore nell'interfaccia utente se provi a salvare FaultRule che fa riferimento a un criterio non ancora creato).

Aggiunta di criteri a una regola di errore

Sebbene sia possibile inserire qualsiasi criterio in FaultRule, in genere si utilizza il criterio AssignMessage per generare un messaggio di risposta personalizzato per una condizione di errore. AssegnaMessage consente di configurare una risposta HTTP con payload, codice di stato HTTP, intestazioni e motivazione.

L'esempio seguente mostra una configurazione tipica del regolamento Assegna messaggio:

<AssignMessage name="AM-Invalid-Key">
  <Set>
      <Payload contentType="text/plain">That is an error.</Payload>
      <StatusCode>401</StatusCode>
  </Set>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</AssignMessage>

Tieni presente che non specifica un elemento <AssignTo>. Ciò significa che verrà assegnato al messaggio ambientale, a seconda di dove è allegato il criterio.

Ora puoi utilizzare questo criterio in FaultRule. Nota come fai riferimento al criterio AssignMessage per nome in FaultRule:

<ProxyEndpoint name="default">
  ...
  <FaultRules>
    <FaultRule name="invalid_key_rule">
      <Step>
        <Name>AM-Invalid-Key</Name>
      </Step>
      <Condition>fault.name = "InvalidApiKey"</Condition>
    </FaultRule>
  </FaultRules>
</ProxyEndpoint>

Quando esegui il deployment della configurazione precedente, il proxy API eseguirà il criterio AssignMessage chiamato AM-Invalid-Key ogni volta che un'app presenta una chiave API non valida.

Puoi eseguire più criteri in una regola di errore, come illustrato nell'esempio seguente:

<ProxyEndpoint name="default">
  ...
  <FaultRules>
    <FaultRule name="invalid_key_rule">
      <Step>
        <Name>AM-Invalid-Key</Name>
      </Step>
      <Step>
        <Name>policy2</Name>
      </Step>
      <Step>
        <Name>policy3</Name>
      </Step>
      <Condition>fault.name = "InvalidApiKey"</Condition>
    </FaultRule>
  </FaultRules>
</ProxyEndpoint>

I criteri vengono eseguiti nell'ordine definito. Ad esempio, puoi utilizzare il criterio di registrazione dei messaggi, il criterio di estrazione delle variabili, il criterio Assegna messaggio o qualsiasi altro criterio in FaultRule. Tieni presente che l'elaborazione della regola di errore si interrompe immediatamente se una delle seguenti situazioni avvengono nel seguente modo:

  • Qualsiasi criterio in FaultRule causa un errore
  • Uno dei criteri in FaultRule è di tipo RaiseFault

Definizione del messaggio di errore personalizzato restituito da una regola di errore

Come best practice, devi definire risposte di errore chiare dal tuo su quelle di livello inferiore. In questo modo, potrai fornire ai tuoi clienti informazioni coerenti e utili.

Il seguente esempio di criterio AssignMessage utilizza i tag <Payload> e <StatusCode> per definire la risposta personalizzata all'errore inviata al client in caso di errore InvalidApiKey (vedi l'esempio precedente di FaultRules).

<AssignMessage name="AM-Invalid-Key">
  <Set>
    <Payload contentType="text/plain">You have attempted to access a resource without the correct authorization.
       Contact support at support@mycompany.com.</Payload>
    <StatusCode>401</StatusCode>
  </Set>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</AssignMessage>

Questa risposta include:

  • Il payload contenente il messaggio di errore e un indirizzo email per contattare l'assistenza.
  • Il codice di stato HTTP restituito nella risposta.
  • La frase del motivo, che è una breve descrizione dell'errore.

Creazione di una regolaFaultDefault

Una regola predefinitaFaultRule agisce come gestore di eccezioni per qualsiasi errore non gestito esplicitamente dal un'altra regola Fault. Se le condizioni per tutte le regole FaultRules non corrispondono all'errore, la regola DefaultFaultRule gestisce l'errore. Attiva la gestione degli errori predefiniti aggiungendo il tag <DefaultFaultRule> come elemento secondario di un ProxyEndpoint o di un TargetEndpoint.

Ad esempio, la configurazione TargetEndpoint seguente definisce una regola predefinitoFault che richiama un oggetto criterio denominato AM-Return-Generic-Error:

<TargetEndpoint name="default">
  ...
  <FaultRules>
    ...
  </FaultRules>

  <DefaultFaultRule name="fault-rule">
    <Step>
      <Name>AM-Return-Generic-Error</Name>
    </Step>
  </DefaultFaultRule>

  <HTTPTargetConnection>
    <URL>https://mytarget.example.net</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

La regola predefinitaFaultRule viene generalmente utilizzata per restituire un messaggio di errore generico per qualsiasi , ad esempio un messaggio che contiene i dati di contatto per l'assistenza tecnica. Questo valore predefinito la risposta ha il duplice scopo di fornire informazioni a misura di sviluppatore e allo stesso tempo offuscare gli URL di backend o altre informazioni che potrebbero essere utilizzate per compromettere il sistema.

Ad esempio, definisci il seguente criterio AssignMessage per restituire un errore generico:

<AssignMessage name="AM-Return-Generic-Error">
  <Set>
    <Payload type="text/plain">SERVICE UNAVAILABLE. PLEASE CONTACT SUPPORT: support@company.com.</Payload>
  </Set>
</AssignMessage>

Includi l'elemento <AlwaysEnforce> in <DefaultFaultRule> per eseguire la regola predefinitaFaultRule per ogni errore, anche se è già stata eseguita un'altra FaultRule. DefaultFaultRule è sempre l'ultima regola FaultRule eseguita:

  <DefaultFaultRule name="fault-rule">
    <Step>
      <Name>AM-Return-Generic-Error</Name>
    </Step>
    <AlwaysEnforce>true</AlwaysEnforce>
  </DefaultFaultRule>

La regola predefinitoFault consente di determinare il tipo di errore che si verifica quando altrimenti non è in grado di stabilirlo. Ad esempio, se il proxy API non funziona a causa di un errore che hai non è in grado di determinare, puoi utilizzare la regola predefinitaFault per richiamare il criterioAssignMessage seguente. Questo criterio scrive il valore fault.name in un'intestazione denominata Unhandled-Fault nella risposta:

<AssignMessage name="AM-Set-Fault-Header">
  <Set>
    <Headers>
      <Header name="Unhandled-Fault">{fault.name}</Header>
    </Headers>
  </Set>
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</AssignMessage>

Puoi quindi visualizzare l'intestazione nello strumento di debug o nella risposta per vedere cosa ha causato l'errore.

Aggiunta del logging dei messaggi alla PostClientFlow

PostClientFlow è l'unico flusso che viene eseguito dopo che il proxy ha inserito l'errore stato. A questo flusso può essere associato solo il criterio di registrazione dei messaggi, che viene eseguito dopo che la risposta è stata inviata nuovamente al client. Anche se l'associazione del criterio di registrazione dei messaggi a questo flusso non è tecnicamente una gestione degli errori, puoi utilizzarlo per registrare le informazioni in caso di errore. Perché indipendentemente dall'esito positivo o negativo del proxy, puoi creare il logging dei messaggi i criteri in PostClientFlow e ne garantisce l'esecuzione.

Gestione degli errori dei criteri all'interno del flusso corrente

Gli esempi mostrati finora utilizzano tutti una regola di errore su ProxyEndpoint o TargetEndpoint per gestire eventuali errori dei criteri nell'ambito dello stato di errore. Questo perché il valore predefinito L'elemento continueOnError di un criterio è false, il che significa che quando un si verifica in un criterio, il controllo viene indirizzato allo stato di errore. Una volta nello stato di errore, non puoi restituire il controllo alla pipeline normale e in genere restituisci una forma di messaggio di errore all'app chiamante.

Tuttavia, se imposti l'elemento continueOnError su true per un criterio, il controllo rimane nel flusso corrente e il criterio successivo nella pipeline viene eseguito dopo il criterio che ha causato l'errore. Il vantaggio di gestire l'errore nel flusso attuale è che potrebbe avere un modo per recuperare dall'errore e completare l'elaborazione della richiesta.

Di seguito è riportato un criterio VerifyAPIKey denominato verify-api-key con l'elemento continueOnError impostato su true:

<VerifyAPIKey continueOnError="true" name="verify-api-key">
  <DisplayName>Verify API Key</DisplayName>
  <APIKey ref="request.queryparam.apikey"/>
</VerifyAPIKey>

Se la chiave API manca o non è valida, il criterio VerifyAPIKey imposta la oauthV2.verify-api-key.failed per true, ma in fase di elaborazione continua nel flusso attuale.

Aggiungi quindi il criterio VerifyAPIKey come passaggio nel PreFlow di ProxyEndpoint:

<ProxyEndpoint name="default">
  ...
  <PreFlow name="PreFlow">
    <Request>
      <Step>
        <Name>verify-api-key</Name>
      </Step>
      <Step>
        <Name>FaultInFlow</Name>
        <Condition>oauthV2.verify-api-key.failed = "true"</Condition>
      </Step>
    </Request>
    <Response/>
  </PreFlow>      
</ProxyEndpoint>

Nota come il passaggio successivo nel PreFlow utilizza una condizione per verificare l'esistenza di un . Se si è verificato un errore nel criterio VerifyAPIKey, viene eseguito il criterio FaultInFlow. In caso contrario, il criterio FaultInFlow viene saltato. Il criterio FaultInFlow può fare molte cose, ad esempio registrare l'errore, tentare di correggerlo o eseguire un'altra azione.

Attivazione di un errore mediante il criterio RaiseFault

Puoi utilizzare il criterio RaiseFault in qualsiasi momento in un flusso per attivare un errore. Quando viene eseguito un criterio RaiseFault, il flusso corrente viene terminato e il controllo viene trasferito allo stato di errore.

Un utilizzo del criterio RaiseFault è verificare la presenza di una condizione specifica che un altro criterio potrebbe non rilevare. Nell'esempio precedente, hai aggiunto un tag <Condition> a un Tag <Step> PreFlow che ha causato l'esecuzione del criterio FaultInFlow se la condizione è soddisfatta. Se FaultInFlow è un criterio RaiseFault, controlla vengono trasferiti allo stato di errore. In alternativa, puoi inserire un criterio RaiseFault in un flusso per eseguire il debug e testare le regole di errore.

Quando un criterio RaiseFault attiva un errore, puoi usare la seguente regola e condizione di errore per elaborarlo:

<FaultRule name="raisefault_rule">
  <Step>
    <Name>POLICY-NAME-HERE</Name>
  </Step>
  <Condition>fault.name = "RaiseFault"</Condition>
</FaultRule>

Tieni presente che la condizione verifica la presenza di un errore denominato RaiseFault. Il criterio RaiseFault imposta sempre il valore di fault.name su RaiseFault. Puoi anche Impostare variabili personalizzate all'interno di un criterio RaiseFault. Se lo fai, puoi testare le variabili all'interno degli elementi Condition.

Gestione personalizzata dei codici di errore HTTP dal server di destinazione

Gli esempi riportati nelle sezioni precedenti si applicano agli errori creati dalle norme. Tuttavia, puoi anche creare una risposta personalizzata per gli errori a livello di trasporto, ovvero gli errori HTTP restituiti dal server di destinazione. Per controllare la risposta da un errore HTTP, configura un TargetEndpoint in per elaborare i codici di risposta HTTP.

Per impostazione predefinita, Apigee considera i codici di risposta HTTP nell'intervallo 1xx-3xx come success e HTTP codici di risposta nell'intervallo 4xx-5xx come errore. Ciò significa che qualsiasi risposta del servizio di backend con un codice di risposta HTTP 4xx-5xx invoca automaticamente lo stato di errore, che poi restituisce un messaggio di errore direttamente al client richiedente.

Puoi creare gestori personalizzati per qualsiasi codice di risposta HTTP. Ad esempio, potresti non volere tratta tutti i codici di risposta HTTP nell'intervallo 4xx-5xx come "errore" ma solo 5xx o potresti volere per restituire messaggi di errore personalizzati per i codici di risposta HTTP 400 e 500.

Nell'esempio seguente, utilizzi la proprietà success.codes per configurare TargetEndpoint in modo da trattare i codici di risposta HTTP 400 e 500 come riusciti, insieme ai codici HTTP predefiniti. Trattando questi codici come un successo, TargetEndpoint assume il controllo dell'elaborazione del messaggio di risposta anziché invocare lo stato di errore:

<TargetEndpoint name="default">
  ...
  <HTTPTargetConnection>
    <Properties>
          <Property name="success.codes">1xx,2xx,3xx,400,500</Property>
    </Properties>
    <URL>http://weather.yahooapis.com</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

Come puoi vedere in questo esempio, puoi utilizzare i caratteri jolly per impostare la proprietà success.codes su un intervallo di valori.

L'impostazione della proprietà success.codes sovrascrive i valori predefiniti. Pertanto, se vuoi aggiungere il codice HTTP 400 all'elenco delle operazioni riuscite predefinite, codici, imposta questa proprietà come:

<Property name="success.codes">1xx,2xx,3xx,400</Property>

Tuttavia, se vuoi che il codice HTTP 400 venga considerato come un codice di operazione corretta, imposta la proprietà come:

<Property name="success.codes">400</Property>

Ora puoi definire gestori personalizzati per i codici di risposta HTTP 400 e 500 per restituire un messaggio di risposta personalizzato all'app che effettua la richiesta. Il seguente TargetEndpoint utilizza il criterio denominato ReturnError per gestire i codici di risposta HTTP 400 e 500:

<TargetEndpoint name="default">
  <PreFlow name="PreFlow">
    <Request/>
    <Response>
      <Step>
        <Name>ReturnError</Name>
        <Condition>(response.status.code = 400) or (response.status.code = 500)</Condition>
      </Step>
    </Response>
  </PreFlow>

  <HTTPTargetConnection>
    <Properties>
      <Property name="success.codes">1xx,2xx,3xx,400,500</Property>
    </Properties>
    <URL>http://weather.yahooapis.com</URL>
  </HTTPTargetConnection>
</TargetEndpoint>

Questa configurazione di TargetEndpoint fa sì che il criterio chiamato ReturnError gestisca la risposta ogni volta che TargetEndpoint incontra un codice di risposta HTTP 400 O 500.

Tassonomia degli errori

API Services organizza gli errori nelle seguenti categorie e sottocategorie.

Categoria Sottocategoria Nome errore Descrizione
Messaggistica Errori che si verificano durante il flusso dei messaggi (esclusi gli errori dei criteri)
Errori personalizzati {fault_name} Eventuali errori gestiti esplicitamente dal proxy API utilizzando il criterio RaiseFault
Codici di risposta Errore server interno, non trovato Codici di errore HTTP 5xx, 4xx
Errori di routing NoRoutesMatched Impossibile selezionare un endpoint di destinazione denominato per una richiesta
Errori di classificazione NotFound Errori causati da un URI di richiesta che non corrisponde a nessun BasePath per nessuna configurazione di ProxyEndpoint (ovvero nessun proxy API corrisponde all'URL nella richiesta dell'app client)
Trasporti Errori a livello di trasporto HTTP
Connettività ConnectionRefused, ConnectionReset, ConnectionTimeout Gli errori si verificano durante la creazione di connessioni a livello di rete o di trasporto
Richiedi convalide Mancante ContentLength, HostHeaderMissing Gli errori si verificano durante i controlli della semantica su ogni richiesta
Convalide delle risposte Gli errori si verificano durante i controlli semantici su ogni risposta
Errori IO SSLHandshakeError, ReadTimeout, ReadError, WriteTimeout, WriteError, ChunkError Errori di lettura/scrittura negli endpoint client o di destinazione, timeout, errori TLS/SSL e suddivisi in blocchi errori
Sistema Errori di runtime non definiti
Memoria OutOfMemory, GCOverLimit Errori relativi alla memoria
Thread RogueTaskTerminated Errori come l'interruzione di attività inutilizzate
Norme Gli errori per ogni tipo di criterio sono definiti in Riferimento ai criteri.

Un errore è sempre accompagnato da una descrizione testuale del motivo dell'errore. Quando il sistema genera un errore, viene compilato un insieme di attributi per facilitare la risoluzione dei problemi. Un errore include le seguenti informazioni:

  • Motivo
  • Attributi personalizzati definiti dall'utente