Norme relative a PublishMessage

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Panoramica

Il criterio PublishMessage ti consente di pubblicare le informazioni sul flusso proxy API in un argomento 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 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.

Si tratta di un criterio standard e può essere implementato in qualsiasi tipo di ambiente. Per informazioni sui tipi di criteri e sulla loro disponibilità in ogni 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 di Identity and Access Management (IAM) per Pub/Sub, consulta Autorizzazioni e ruoli.

<PublishMessage>

Specifica il criterio PublishMessage.

La tabella seguente fornisce una descrizione generale degli elementi secondari di <PublishMessage>:

La sintassi dell'elemento <PublishMessage> è la seguente:

<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>

<PublishMessage continueOnError="false" enabled="true" name="Publish-Message-1">
    <DisplayName>Publish Message-1</DisplayName>
    <Source>this is a message template {flow-variable1}</Source>
    <CloudPubSub>
        <Topic>projects/{flow-variable-project-id}/topics/{flow-variable-topic-name}</Topic>
    </CloudPubSub>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</PublishMessage>

<PublishMessage continueOnError="false" enabled="true" name="Publish-Message-2">
    <UseMessageAsSource>request</UseMessageAsSource>
    <CloudPubSub>
        <Topic>projects/{flow-variable-project-id}/topics/{flow-variable-topic-name}</Topic>
    </CloudPubSub>
    <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
</PublishMessage>

<PublishMessage name="Publish-Message-3">
  <Source>this is a message template {flow-variable1}</Source>
  <Attributes>
    <Attribute name='attr-name-0'>fixed-value</Attribute>
    <Attribute name='another-attribute-name'>{request.queryparam.attr1}</Attribute>
    <Attribute name='a-third-attribute-name'>{request.queryparam.attr2:default-value}</Attribute>
  </Attributes>
  <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:

Riferimento all'elemento secondario

<Attributes>

Specifica gli attributi da associare al messaggio Pub/Sub.

Ogni attributo è una coppia chiave-valore. Il nome associato all'attributo deve essere univoco. Il valore di ciascuno viene determinato dinamicamente in fase di esecuzione tramite un modello di messaggio.

La sintassi dell'elemento <Attributes> è la seguente:

  <Attributes>
    <Attribute name='NAME-1'>fixed-value</Attribute>
    <Attribute name='NAME-2'>{flow-variable}</Attribute>
    ...
    <Attribute name='NAME-N'>message template here {flow-variable:default-value}</Attribute>
  </Attributes>

<PublishMessage name="PM-with-one-attribute">
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <Source>{request.queryparam.message}</Source>
  <Attributes>
    <Attribute name='my-attribute-1'>fixed-value</Attribute>
  </Attributes>
  <CloudPubSub>
    <Topic>projects/{request.queryparam.project}/topics/{request.queryparam.topic}</Topic>
  </CloudPubSub>
</PublishMessage>

<PublishMessage name="PM-with-multiple-attributes">
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <Source>{my-assembled-message}</Source>
  <Attributes>
    <Attribute name='attr-0'>fixed-value</Attribute>
    <Attribute name='attr-1'>{flow-variable1}</Attribute>
    <Attribute name='attr-2'>fixed portion {flow-variable2:default-value}</Attribute>
  </Attributes>
  <CloudPubSub>
    <Topic>projects/{propertyset.settings.project}/topics/{propertyset.settings.topic}</Topic>
  </CloudPubSub>
</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.

La sintassi dell'elemento <DisplayName> è la seguente:

<PolicyElement>
  <DisplayName>POLICY_DISPLAY_NAME</DisplayName>
  ...
</PolicyElement>

<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.

La sintassi dell'elemento <Source> è la seguente:

 <Source>SOURCE</Source>

<Source>{flow-var-1}</Source>

<PublishMessage name="PM-with-source-template">
  <Source>{
    "name": "value-1",
    "count": "{flow-variable1}",
    "action": "{flow-variable2}"
  }</Source>
  <Attributes>
    <Attribute name='content-type'>application/json</Attribute>
  </Attributes>
  <CloudPubSub>
    <Topic>projects/{propertyset.settings.project}/topics/{propertyset.settings.topic}</Topic>
  </CloudPubSub>
</PublishMessage>

<CloudPubSub>

Elemento principale di <Topic>.

Puoi pubblicare in un solo argomento Pub/Sub. Di conseguenza, puoi avere un solo elemento <Topic> nell'elemento <CloudPubSub>.

La sintassi dell'elemento <CloudPubSub> è la seguente:

<CloudPubSub>
  <Topic>TOPIC_NAME</Topic>
</CloudPubSub>

<CloudPubSub>
  <Topic>projects/{my-project}/topics/{my-topic}</Topic>
</CloudPubSub>

<Topic>

Specifica l'argomento Pub/Sub a cui vuoi pubblicare il messaggio <Source>.

Devi specificare il nome dell'argomento nel formato projects/project-id/topics/topic-name.

La sintassi dell'elemento <Topic> è la seguente:

<Topic>TOPIC_NAME</Topic>

<Topic>projects/project-id-marketing/topics/topic-name-test1</Topic>

<UseMessageAsSource>

Specifica il messaggio da pubblicare.

Utilizzalo come alternativa all'elemento <Source>. Il valore deve essere il nome di una variabile di flusso che fa riferimento a un messaggio, ad esempio request, response o message. Quando specifichi questo elemento, il criterio utilizza i contenuti del messaggio come messaggio da pubblicare. Devi utilizzare questo elemento anziché <Source> quando i contenuti del messaggio sono uno stream di ottetti che non può essere rappresentato come stringa, ad esempio i contenuti di un file binario.

La sintassi dell'elemento <UseMessageAsSource> è la seguente:

<PublishMessage name="PM-with-use-message-as-source">
  <UseMessageAsSource>MESSAGE_NAME</UseMessageAsSource>
  <Attributes>
    <Attribute name='attr-1'>{flowvar1}</Attribute>
  </Attributes>
  <CloudPubSub>
    <Topic>projects/{flowvar1}/topics/{flowvar-topic}</Topic>
  </CloudPubSub>
</PublishMessage>

<PublishMessage name="PM-with-use-message-as-source">
  <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
  <UseMessageAsSource>request</UseMessageAsSource>
  <Attributes>
    <Attribute name='attr-1'>{flowvar1}</Attribute>
  </Attributes>
  <CloudPubSub>
    <Topic>projects/{propertyset.settings.project}/topics/{propertyset.settings.topic}</Topic>
  </CloudPubSub>
</PublishMessage>

<IgnoreUnresolvedVariables>

Specifica se l'elaborazione si interrompe se Apigee rileva una variabile non risolta.

Imposta il valore su true per ignorare le variabili non risolte e continuare l'elaborazione; in caso contrario, false. Il valore predefinito è false.

L'impostazione di <IgnoreUnresolvedVariables> su true è diversa dall'impostazione di continueOnError di <PublishMessage> su true. Se imposti continueOnError su true, Apigee ignora tutti gli errori, non solo quelli nelle variabili.

La sintassi dell'elemento <IgnoreUnresolvedVariables> è la seguente:

<IgnoreUnresolvedVariables>[true|false]</IgnoreUnresolvedVariables>

<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 la sezione Utilizzare le variabili di flusso.

Se il criterio PublishMessage pubblica 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 dal flusso di richiesta proxy in poi. 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.

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 dell'edificio.