Questa pagina si applica a Apigee e Apigee ibridi.
Visualizza la documentazione di
Apigee Edge.
Panoramica
Il criterio publishMessage consente di pubblicare le informazioni del flusso proxy API in Google Cloud Pub/Sub. Pub/Sub di Google consente ai servizi di comunicare in modo asincrono, con una latenza notevolmente inferiore. Per ulteriori informazioni su Pub/Sub, consulta Che cos'è Pub/Sub?. Le informazioni che vuoi pubblicare in un argomento Pub/Sub possono essere un testo letterale o una variabile di flusso. Tu puoi anche specificare una combinazione di testo letterale e variabili di flusso utilizzando un modello di messaggio.
Se la richiesta di pubblicazione va a buon fine, Apigee imposta la variabile di flusso publishmessage.message.id
sul valore restituito dal server Pub/Sub. Per ulteriori informazioni, consulta
Voci di flusso.
Questo criterio è un criterio standard e può essere implementato in qualsiasi tipo di ambiente. Per informazioni sui tipi di criteri e sulla loro disponibilità in base a ciascun tipo di ambiente, consulta Tipi di criteri.
Autenticazione e deployment del proxy
Per eseguire il criterio PublishMessage, devi disporre di un token di autenticazione. Tuttavia, nella definizione del criterio non è presente un elemento <Authentication> esplicito. Per utilizzare l'autenticazione Google, devi eseguire il deployment del proxy API, che aggiunge il token di autenticazione alla richiesta sotto il cofano. Per informazioni su come eseguire il deployment di un proxy API che utilizza l'autenticazione Google, consulta
Passaggi di deployment.
Oltre a utilizzare l'autenticazione Google nel proxy API, devi eseguire il deployment del proxy API con un account di servizio che abbia un ruolo con l'autorizzazione pubsub.topics.publish. Per saperne di più sui ruoli IAM (Identity and Access Management) per Pub/Sub,
consulta Autorizzazioni e ruoli.
<PublishMessage>
Specifica il criterio PublishMessage.
| Valore predefinito | N/D |
| Obbligatorio? | Obbligatorio |
| Tipo | Tipo complesso |
| Elemento principale | N/D |
| Elementi secondari |
<CloudPubSub><DisplayName><Source> |
La tabella seguente fornisce una descrizione generale degli elementi secondari di <PublishMessage>:
| Elemento secondario | Obbligatorio? | Descrizione |
|---|---|---|
<CloudPubSub> |
Obbligatorio | Elemento principale di <Topic>. L'elemento <Topic> specifica
l'argomento Pub/Sub in cui vuoi pubblicare il messaggio. |
<DisplayName> |
Facoltativo | Un nome personalizzato per la norma. |
<IgnoreUnresolvedVariables> |
Facoltativo | Specifica se l'elaborazione si interrompe se Apigee incontra una variabile non risolta. |
<Source> |
Obbligatorio | Specifica il messaggio da pubblicare. |
| Altri elementi secondari | ||
<Topic> |
Obbligatorio | Specifica l'argomento Pub/Sub in cui vuoi pubblicare il messaggio. |
L'elemento <PublishMessage> utilizza la seguente sintassi:
Sintassi
<?xml version="1.0" encoding="UTF-8"?><PublishMessage continueOnError="[true|false]" enabled="[true|false]" name="Publish-Message-1">
<DisplayName>DISPLAY_NAME</DisplayName>
<Source>SOURCE_VALUE</Source>
<CloudPubSub>
<Topic>TOPIC_NAME</Topic>
</CloudPubSub>
<IgnoreUnresolvedVariables>[true|false]</IgnoreUnresolvedVariables>
</PublishMessage>Esempio
L'esempio seguente mostra la definizione del criterio <PublishMessage>:
<?xml version="1.0" encoding="UTF-8"?><PublishMessage continueOnError="false" enabled="true" name="Publish-Message-1"> <DisplayName>Publish Message-1</DisplayName> <Source>{flow-variable-1}</Source> <CloudPubSub> <Topic>projects/{flow-variable-project-id}/topics/{flow-variable-topic-name}</Topic> </CloudPubSub> <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables> </PublishMessage>
Questo elemento ha i seguenti attributi comuni a tutti i criteri:
| Attributo | Predefinito | Obbligatorio? | Descrizione |
|---|---|---|---|
name |
N/D | Obbligatorio |
Il nome interno del criterio. Il valore dell'attributo Se vuoi, utilizza l'elemento |
continueOnError |
falso | Facoltativo | 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:
|
enabled |
true | Facoltativo | Imposta su true per applicare il criterio. Imposta su false per disattivare il
criterio. Il criterio non verrà applicato anche se rimane collegato a un flusso. |
async |
falso | Ritirato | Questo attributo è stato ritirato. |
Riferimento elemento secondario
In questa sezione vengono descritti gli elementi secondari di<PublishMessage>.
<DisplayName>
Da utilizzare insieme all'attributo name per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso e più naturale.
L'elemento <DisplayName> è comune a tutti i criteri.
| Valore predefinito | N/D |
| Obbligatorio? | Facoltativo. Se ometti <DisplayName>, viene utilizzato il valore dell'attributo name del criterio. |
| Tipo | Stringa |
| Elemento principale | <PolicyElement> |
| Elementi secondari | Nessuno |
La sintassi dell'elemento <DisplayName> è la seguente:
Sintassi
<PolicyElement> <DisplayName>POLICY_DISPLAY_NAME</DisplayName> ... </PolicyElement>
Esempio
<PolicyElement> <DisplayName>My Validation Policy</DisplayName> </PolicyElement>
L'elemento <DisplayName> non ha attributi o elementi secondari.
<Source>
Specifica il messaggio da pubblicare.
Il messaggio può essere un testo letterale, una variabile di flusso o una combinazione di entrambi sotto forma di modello di messaggio.
| Valore predefinito | N/D |
| Obbligatorio? | Obbligatorio |
| Tipo | Stringa |
| Elemento principale |
<PublishMessage> |
| Elementi secondari | Nessuno |
La sintassi dell'elemento <Source> è la seguente:
Sintassi
<Source>SOURCE</Source>
Esempio 1
L'esempio seguente imposta il messaggio di origine sul valore della variabile di flusso flow-var-1:
<Source>{flow-var-1}</Source>
Esempio 2
L'esempio seguente imposta il messaggio di origine su source-message-text-01:
<Source>source-message-text-01</Source>
<CloudPubSub>
Elemento principale di <Topic>.
Puoi pubblicare in un solo argomento Pub/Sub. Di conseguenza, puoi avere un solo elemento <Topic> nell'elemento
<CloudPubSub>.
| Valore predefinito | N/D |
| Obbligatorio? | Obbligatorio |
| Tipo | Tipo complesso |
| Elemento principale |
<PublishMessage> |
| Elementi secondari |
<Topic> |
L'elemento <CloudPubSub> utilizza la seguente sintassi:
Sintassi
<CloudPubSub> <Topic>TOPIC_NAME</Topic> </CloudPubSub>
Esempio
L'esempio seguente mostra la dichiarazione dell'elemento <CloudPubSub>:
<CloudPubSub>
<Topic>projects/{request.header.project}/topics/{request.header.topic}</Topic>
</CloudPubSub><Topic>
Specifica l'argomento Pub/Sub in cui vuoi pubblicare il messaggio <Source>.
Devi specificare il nome dell'argomento nel formato projects/project-id/topics/topic-name.
| Valore predefinito | N/D |
| Obbligatorio? | Obbligatorio |
| Tipo | Tipo complesso |
| Elemento principale |
<CloudPubSub> |
| Elementi secondari | Nessuno |
L'elemento <Topic> utilizza la seguente sintassi:
Sintassi
<Topic>TOPIC_NAME</Topic>
Esempio
L'esempio seguente specifica l'argomento Pub/Sub a cui pubblicare:
<Topic>projects/project-id-marketing/topics/topic-name-test1</Topic>
In questo esempio, project-id-marketing è il tuo ID progetto Google Cloud e
topic-name-test1 è il
in cui deve essere pubblicato il messaggio <Source>.
<IgnoreUnresolvedVariables>
Specifica se l'elaborazione si interrompe se Apigee incontra una variabile non risolta.
| Valore predefinito | Falso |
| Obbligatorio? | Facoltativo |
| Tipo | Booleano |
| Elemento principale |
<PublishMessage>
|
| Elementi secondari | Nessuno |
Imposta il valore su true per ignorare le variabili non risolte e continuare l'elaborazione; in caso contrario, false. Il valore predefinito è false.
Impostare <IgnoreUnresolvedVariables> su true è diverso dall'impostare continueOnError di <PublishMessage> su true. Se imposti continueOnError su true, Apigee ignora tutti gli errori, non
solo gli errori nelle variabili.
La sintassi dell'elemento <IgnoreUnresolvedVariables> è la seguente:
Sintassi
<IgnoreUnresolvedVariables>[true|false]</IgnoreUnresolvedVariables>
Esempio
L'esempio seguente imposta <IgnoreUnresolvedVariables> su true:
<IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
Variabili di flusso
Le variabili di flusso sono oggetti che contengono dati specifici e sono disponibili nel contesto di un flusso di proxy API. Queste variabili memorizzano informazioni quali informazioni sul payload, percorso dell'URL, indirizzi IP e dati dell'esecuzione delle norme. Per ulteriori informazioni sulle variabili di flusso, consulta Utilizzo delle variabili di flusso.
Se il criterio PublishMessage pubblica correttamente il messaggio nell'argomento Pub/Sub,
Apigee imposta la variabile di flusso publishmessage.message.id sul valore messageId restituito dal
server Pub/Sub. La variabile di flusso è di tipo stringa ed è a tua disposizione
a partire dal flusso di richieste proxy. In base alle tue esigenze, puoi utilizzare la variabile di flusso in altri criteri downstream. Tuttavia, se la pubblicazione non va a buon fine, Apigee non imposta la variabile publishmessage.message.id e l'accesso a questa variabile causerà errori.
Per ulteriori informazioni sui vari tipi di variabili di flusso, consulta Riferimento alle variabili di flusso.
Codici 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 |
|---|---|---|
steps.publishmessage.PermissionDeniedError |
500 |
Questo errore si verifica quando l'account di servizio di runtime non può rubare l'identità dell'account di servizio proxy o quando l'account di servizio proxy non dispone dell'autorizzazione per pubblicare nell'argomento. |
steps.publishmessage.ExecutionError |
500 |
Questo errore si verifica se si è verificato un errore imprevisto durante la pubblicazione del messaggio in Pub/Sub. Puoi visualizzare i dettagli dell'errore nel messaggio di errore. |
Variabili di errore
Ogni volta che si verificano errori di esecuzione in un criterio, Apigee genera messaggi di errore. Puoi visualizzare questi messaggi di errore nella risposta di errore. Spesso i messaggi di errore generati dal sistema potrebbero non essere pertinenti nel contesto del tuo prodotto. Ti consigliamo di personalizzare i messaggi di errore in base al tipo di errore per renderli più significativi.
Per personalizzare i messaggi di errore, puoi utilizzare le regole di errore o il criterio RaiseFault. Per
informazioni sulle differenze tra le regole di errore e il criterio RaiseFault, consulta
Regole di errore e criterio RaiseFault.
Devi verificare la presenza di condizioni utilizzando l'elemento Condition sia nelle regole di errore sia nel criterio RaiseFault.
Apigee fornisce variabili di errore univoche per ogni criterio e i valori delle variabili di errore vengono impostati quando un criterio attiva errori di runtime.
Utilizzando queste variabili, puoi verificare la presenza di condizioni di errore specifiche e intraprendere le azioni appropriate. Per ulteriori informazioni su come controllare le condizioni di errore, consulta Condizioni di compilazione.
| Variabili | Dove | Esempio |
|---|---|---|
fault.name |
fault.name può corrispondere a uno dei problemi elencati nella tabella Errori di runtime.
Il nome dell'errore è l'ultima parte del codice dell'errore. |
fault.name Matches "UnresolvedVariable" |
publishmessage.POLICY_NAME.failed |
POLICY_NAME è il nome specificato dall'utente del criterio che ha generato l'errore. | publishmessage.publish-message-1.failed = true |