Questa pagina si applica ad Apigee e Apigee hybrid.
Visualizza la documentazione di
Apigee Edge.
Questo argomento descrive la struttura degli errori dei criteri e i tipi di variabili di flusso impostate quando si verifica un errore del criterio. Queste informazioni sono essenziali se stai progettando e implementando la gestione degli errori per i tuoi proxy.
Questo argomento presuppone che tu abbia una conoscenza generale del funzionamento della gestione degli errori in Apigee e che tu sappia cosa sono le regole di errore. Se hai bisogno di una revisione, consulta Gestione dei guasti. Le informazioni riportate qui ti aiuteranno anche a navigare e utilizzare il riferimento agli errori delle norme.
Informazioni sulla risposta di errore della norma predefinita
Quando un criterio genera un errore, Apigee entra immediatamente nel flusso di errore e genera un messaggio di errore. Questo messaggio generato dal sistema è un oggetto JSON che include due informazioni: un errorcode e un faultstring.
Ad esempio:
{ "fault":{ "detail":{ "errorcode":"steps.extractvariables.SourceMessageNotAvailable" }, "faultstring":"mymessage message is not available for ExtractVariable: ParseJsonResponse" } }
Analizziamo rapidamente questo messaggio di errore:
errorcode è costituito da un prefix e un error
name, come segue: [prefix].[error_name]. Nell'esempio riportato sopra, steps.extractvariables è il prefisso e SourceMessageNotAvailable è il nome dell'errore. Il prefisso indica il tipo di norma che ha generato l'errore. Nell'esempio riportato sopra, puoi capire che l'errore è stato generato da un criterio ExtractVariables e che il nome dell'errore è SourceMessageNotAvailable.
faultstring contiene una descrizione dell'errore. La stringa di errore solitamente include indizi che ti aiutano a trovare il problema specifico che ha causato l'errore, ad esempio il nome del criterio, il nome di una variabile non risolta o qualsiasi elemento che ha contribuito all'errore. Ad esempio, nel messaggio di errore riportato sopra, mymessage è il nome di una variabile di messaggio non risolta a cui viene fatto riferimento nel criterio e ParseJsonResponse è il nome del criterio che ha attivato l'errore.
Variabili specifiche per gli errori dei criteri
Quando viene attivato un errore del criterio, vengono compilate alcune variabili di flusso specifiche per l'errore. Queste variabili sono estremamente utili nella gestione degli errori. Come spiegato in Gestione degli errori, è prassi comune intercettare gli errori dei criteri generati dal sistema ed eseguire un'azione successiva, ad esempio creare una risposta di errore personalizzata. Ad esempio, per motivi di sicurezza, potresti voler impedire ai client di vedere gli errori e i codici di stato effettivi restituiti da Apigee.
La variabile fault.name
Quando un criterio genera un errore, imposta la variabile di flusso fault.name sulla parte error_name del codice errore (come descritto nella sezione precedente). È molto comune valutare questa variabile per eseguire condizionatamente le regole di errore.
Ecco un esempio di regola di errore che verifica il valore di fault.name:
<faultrule name="VariableOfNonMsgType"></faultrule><FaultRule name="Source Message Not Available Fault">
<Step>
<Name>AM-CustomErrorMessage</Name>
<Condition>(fault.name Matches "SourceMessageNotAvailable") </Condition>
</Step>
</FaultRule>Devi ricordare che quando un criterio attiva un errore, la variabile fault.name
viene sempre impostata sul nome dell'errore.
La
variabile [prefix].[policy_name].failed
Oltre a fault.name, un'altra variabile che gli sviluppatori controllano di solito è il flag [prefix].[policy_name].failed, che viene impostato su true o false quando viene eseguito un criterio. Nelle regole di errore, devi controllare quando è true, ovvero se si è verificato un errore. Ecco come creare un'espressione condizionale che controlli il flag [prefix].[policy_name].failed. Per controllare correttamente questa variabile, devi sapere due cose:
- Il nome del criterio che stai controllando. Si tratta del valore dell'attributo name del criterio, non del nome visualizzato. Questo attributo è sempre incluso nel file XML della definizione del criterio.
- Un prefisso specifico per il tipo di criterio che stai controllando. Di seguito spiegheremo come trovare il prefisso.
Per esemplificare, ecco un altro esempio di regola di errore. Nella condizione esterna, nota come viene formato il nome della variabile [prefix].[policy_name].failed. In questo caso il prefisso è
extractvariables e il nome della norma è ParseJsonResponse. In questo
caso, la regola di errore verrà eseguita solo se questa variabile è vera. Ecco un suggerimento: poiché le regole di errore possono contenere più passaggi, questo pattern è un ottimo modo per organizzarle in blocchi.
<faultrule name="VariableOfNonMsgType"></faultrule><FaultRule name="Extract Variable Faults"> <Step> <Name>AM-CustomErrorMessage</Name> <Condition>(fault.name Matches "SourceMessageNotAvailable") </Condition> </Step> <Condition>(extractvariables.ParseJsonResponse.failed = true) </Condition> </FaultRule>
Informazioni sulle variabili error e message
La variabile error è disponibile solo nel flusso di errore di un proxy. Puoi ottenere informazioni utili dalla variabile error, ad esempio il messaggio di errore, il codice stato, la frase del motivo e così via. Il pattern di formattazione per la variabile errore è il seguente:
error.ERROR_COMPONENT = VALUE
Ad esempio:
error.message = "request message is not available for ExtractVariable: ParseJsonResponse"
e
error.status.code = "500"
La variabile message è disponibile anche nel flusso di errori e può essere utilizzata per scopi simili a quelli della variabile error. La variabile messaggio è speciale perché è contestuale. In un flusso di richieste, si comporta come una variabile di richiesta, mentre in un flusso di risposte può essere utilizzata per ottenere/impostare i valori di risposta.
Fai riferimento alla documentazione di riferimento delle variabili di flusso per informazioni su tutte le variabili Apigee, tra cui error e message.