Questa pagina si applica ad Apigee e Apigee hybrid.
Visualizza la documentazione di
Apigee Edge.
Panoramica
Il criterio publishMessage consente di pubblicare le informazioni sul flusso proxy API in un argomento di 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. Puoi anche specificare una combinazione di testo letterale e variabili di flusso utilizzando un modello di messaggio.
Se la richiesta di pubblicazione ha esito positivo, Apigee imposta la variabile di flusso publishmessage.message.id sul valore restituito dal server Pub/Sub. Per maggiori informazioni, consulta
Variabili di flusso.
Questo è un criterio standard e può essere implementato in qualsiasi tipo di ambiente. Non tutti gli utenti devono conoscere i tipi di criteri e di ambiente. Per informazioni sui tipi di criteri e sulla disponibilità con ogni tipo di ambiente, consulta Tipi di criteri.
Autenticazione e deployment del proxy
Per eseguire il criterio publishMessage, è necessario un token di autenticazione. Tuttavia, non è presente alcun elemento <Authentication> esplicito nella definizione del criterio. Devi eseguire il deployment del proxy API per utilizzare l'autenticazione di Google, che aggiunge il token di autenticazione alla richiesta in background. Per informazioni su come eseguire il deployment di un proxy API che utilizza l'autenticazione Google, consulta Procedura 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 maggiori informazioni sui ruoli IAM (Identity and Access Management) per Pub/Sub, consulta Autorizzazioni e ruoli.
<PublishMessage>
Specifica il criterio PubblicaMessage.
| 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 il criterio. |
<IgnoreUnresolvedVariables> |
Facoltativo | Specifica se l'elaborazione si interrompe se Apigee rileva 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/A | Obbligatorio |
Il nome interno del criterio. Il valore dell'attributo Facoltativamente, utilizza l'elemento |
continueOnError |
falso | Facoltativo | Imposta su false per restituire un errore in caso di errore del criterio. Questo è un comportamento previsto per
la maggior parte dei criteri. Imposta su true per continuare l'esecuzione del flusso anche dopo un errore nel 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 | Deprecato | Questo attributo è stato ritirato. |
Riferimento elemento secondario
In questa sezione vengono descritti gli elementi secondari di<PublishMessage>.
<DisplayName>
Utilizzalo in aggiunta 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/A |
| Obbligatorio? | Facoltativo. Se ometti <DisplayName>, viene utilizzato il valore dell'attributo name del criterio. |
| Tipo | Stringa |
| Elemento principale | <PolicyElement> |
| Elementi secondari | Nessuna esperienza |
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 | Nessuna |
L'elemento <Source> utilizza la seguente sintassi:
Sintassi
<Source>SOURCE</Source>
Example-1
Nell'esempio seguente il messaggio di origine viene impostato sul valore della variabile di flusso flow-var-1:
<Source>{flow-var-1}</Source>
Example-2
Nell'esempio seguente il messaggio di origine viene impostato 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 | Nessuna |
L'elemento <Topic> utilizza la seguente sintassi:
Sintassi
<Topic>TOPIC_NAME</Topic>
Esempio
Nell'esempio seguente è specificato l'argomento Pub/Sub in cui pubblicare:
<Topic>projects/project-id-marketing/topics/topic-name-test1</Topic>
In questo esempio, project-id-marketing è l'ID progetto Google Cloud e
topic-name-test1 è l'argomento
in cui deve essere pubblicato il messaggio <Source>.
<IgnoreUnresolvedVariables>
Specifica se l'elaborazione si interrompe se Apigee rileva una variabile non risolta.
| Valore predefinito | Falso |
| Obbligatorio? | Facoltativo |
| Tipo | Booleano |
| Elemento principale |
<PublishMessage>
|
| Elementi secondari | Nessuna |
Imposta il valore su true per ignorare le variabili non risolte e continuare l'elaborazione. In caso contrario, imposta il valore su false. Il
valore predefinito è false.
L'impostazione di <IgnoreUnresolvedVariables> su true è diversa dall'impostazione di continueOnError su true di <PublishMessage>. Se imposti continueOnError su true, Apigee ignora tutti gli errori, non solo quelli nelle variabili.
L'elemento <IgnoreUnresolvedVariables> utilizza la seguente sintassi:
Sintassi
<IgnoreUnresolvedVariables>[true|false]</IgnoreUnresolvedVariables>
Esempio
Nell'esempio seguente viene impostato il valore <IgnoreUnresolvedVariables> su true:
<IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
Variabili di flusso
Le variabili di flusso sono oggetti contenenti dati specifici e disponibili nel contesto di un flusso proxy API. Queste variabili memorizzano informazioni come informazioni sul payload, il percorso dell'URL, gli indirizzi IP e i dati dell'esecuzione del criterio. Per saperne di più sulle variabili di flusso, consulta la sezione Utilizzo delle variabili di flusso.
Se il criterio publishMessage viene pubblicato correttamente 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 è disponibile per te a partire dal flusso di richieste proxy. In base alle tue esigenze, puoi utilizzare la variabile di flusso in altri criteri a valle. 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 maggiori informazioni sui vari tipi di variabili di flusso, consulta Riferimento per le variabili di flusso.
Codici di errore
Questa sezione descrive i codici e i messaggi di errore che vengono restituiti e le variabili di errore impostate da Apigee quando questo criterio attiva un errore. Queste informazioni sono importanti per sapere se si stanno sviluppando regole di errore per gestire gli errori. Per scoprire di più, consulta gli articoli Cosa devi sapere sugli errori relativi alle norme e Gestione degli errori.
Errori di runtime
Questi errori possono verificarsi quando il criterio viene eseguito.
| Codice di errore | Stato HTTP | Causa |
|---|---|---|
steps.publishmessage.PermissionDeniedError |
500 |
Questo errore si verifica quando l'account di servizio di runtime non può rappresentare l'account di servizio proxy o l'account di servizio proxy non ha l'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. Molte volte, i messaggi di errore generati dal sistema potrebbero non essere pertinenti nel contesto del prodotto. Per rendere i messaggi più significativi, potresti voler personalizzare i messaggi in base al tipo di errore.
Per personalizzare i messaggi di errore, puoi utilizzare regole di errore o il criterio AlzaFault. Per informazioni sulle differenze tra le regole di errore e il criterio RaiseFault, consulta FaultRules e il criterio AlzaFault.
Devi verificare le condizioni utilizzando l'elemento Condition sia nelle regole di errore sia nel criterio AlzaFault.
Apigee fornisce variabili di errore univoche per ciascun criterio e i relativi valori vengono impostati quando un criterio attiva gli errori di runtime.
Utilizzando queste variabili, puoi verificare le condizioni di errore specifiche e intraprendere le azioni appropriate. Per saperne di più sul controllo delle condizioni di errore, consulta Condizioni di costruzione.
| Variabili | Dove | Esempio |
|---|---|---|
fault.name |
fault.name può corrispondere a qualsiasi errore elencato nella tabella Errori di runtime.
Il nome del guasto è l'ultima parte del codice di 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 |