Questa pagina si applica a Apigee e Apigee ibrido.
Visualizza la documentazione di
Apigee Edge.
Questo argomento descrive la struttura degli errori dei criteri e i tipi di variabili di flusso che vengono impostati quando si verifica un errore dei criteri. Queste informazioni sono essenziali se stai progettando e implementando la gestione degli errori per i proxy.
Questo argomento presuppone che tu abbia una conoscenza generale di come funziona la gestione degli errori in Apigee e che tu sappia cosa sono le regole di errore. Se hai bisogno di una revisione, consulta Gestione degli errori. Le informazioni qui ti aiuteranno anche a esplorare e utilizzare il Riferimento agli errori relativi ai criteri.
Informazioni sulla risposta di errore del criterio predefinito
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 bit di informazioni: un errorcode e un faultstring.
Ad esempio:
{
"fault":{
"detail":{
"errorcode":"steps.extractvariables.SourceMessageNotAvailable"
},
"faultstring":"mymessage message is not available for ExtractVariable: ParseJsonResponse"
}
}
Scomponiamo rapidamente questo messaggio di errore:
Il errorcode è composto da un prefix e da un error
name, come segue: [prefix].[error_name]. Nell'esempio precedente, "steps.extractvariables è il prefisso e SourceMessageNotAvailable è il nome dell'errore. Il prefisso indica il tipo di criterio che ha generato l'errore. Nell'esempio
riportato sopra, puoi capire che l'errore è stato generato da un criterio TakeoutVariables e che il nome dell'errore è
SourceMessageNotAvailable.
faultstring contiene una descrizione dell'errore. La stringa di errore in genere include indizi per aiutarti 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 altro fattore 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, mentre ParseJsonResponse è il nome del criterio che ha attivato l'errore.
Variabili specifiche degli errori dei criteri
Quando viene attivato un errore relativo al criterio, vengono compilate alcune variabili di flusso specifiche dell'errore. Queste variabili sono estremamente utili nella gestione degli errori. Come spiegato nella sezione Gestione degli errori, è pratica comune eseguire il trap degli 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 visualizzare gli errori effettivi e i codici di stato restituiti da Apigee.
Variabile fault.name
Quando un criterio genera un errore, imposta la variabile di flusso fault.name nella
parte error_name del codice di errore (come descritto nella sezione precedente). È pratica comune valutare questa variabile per eseguire regole di errore in modo condizionale.
Di seguito è riportato un esempio di regola di errore che verifica il valore 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>
Tieni presente che quando un criterio attiva un errore, la variabile fault.name
è sempre impostata sul nome dell'errore.
La variabile [prefix].[policy_name].failed
Oltre a fault.name, un'altra variabile controllata solitamente dagli sviluppatori è il flag [prefix].[policy_name].failed, che viene impostato su true o false quando viene eseguito un criterio. Nelle regole di errore, vorrai verificare se è vero, ossia per verificare se si è verificato un errore. Ecco come creare un 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. Questo è il valore dell'attributo nome del criterio, non il nome visualizzato. Questo attributo è sempre incluso nel file XML della definizione del criterio.
- Un prefisso specifico per il tipo di norme che stai controllando. (di seguito spiegheremo come trovare il prefisso.)
Per spiegarci meglio, ecco un altro esempio di regola di errore. Nota nella condizione esterna come viene formato il nome della variabile [prefix].[policy_name].failed. In questo caso il prefisso è
extractvariables e il nome del criterio è ParseJsonResponse. In questo caso, la regola di errore viene eseguita solo se questa variabile è true. Un suggerimento: poiché le regole di errore possono contenere più passaggi, questo pattern è un buon modo per organizzare le regole di errore 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 errori di un
proxy. Puoi ottenere informazioni utili dalla variabile error, ad esempio messaggio di errore, codice di stato, frase del motivo e così via. Il pattern di formattazione per la variabile di errore è il seguente:
error.ERROR_COMPONENT = VALUE
Ad esempio:
error.message = "request message is not available for ExtractVariable: ParseJsonResponse"
and
error.status.code = "500"
La variabile message è disponibile anche nel flusso di errore e può essere utilizzata per scopi simili a quelli della variabile error. La variabile del messaggio è speciale perché è contestuale. In un flusso di richiesta, si comporta come una variabile di richiesta, mentre in un flusso di risposta può essere utilizzato per ottenere/impostare valori di risposta.
Consulta Riferimento per le variabili di flusso
per informazioni su tutte le variabili Apigee, tra cui error e
message.