Norme ServiceCallout

Questa pagina si applica a Apigee e Apigee ibrido.

Visualizza la documentazione di Apigee Edge.

icona norme

Cosa

Il criterio ServiceCallout consente di chiamare un altro servizio dal flusso proxy API. Puoi creare callout a un servizio esterno (ad esempio un endpoint di servizio RESTful esterno) o a servizi interni (ad esempio un proxy API nella stessa organizzazione e nello stesso ambiente).

Questo criterio è un criterio estendibile e il suo utilizzo potrebbe avere implicazioni in termini di costi o utilizzo, a seconda della licenza Apigee. Per informazioni sui tipi di criteri e sulle implicazioni per l'utilizzo, consulta la pagina Tipi di criteri.

  • In un caso d'uso esterno, fai un callout a un'API di terze parti esterna al tuo proxy. La risposta dell'API di terze parti viene analizzata e inserita nel messaggio di risposta dell'API, arricchendo e raggruppando i dati per gli utenti finali dell'app. Puoi anche effettuare una richiesta utilizzando il criterio ServiceCallout nel flusso delle richieste, quindi passare le informazioni nella risposta al TargetEndpoint del proxy API.
  • In un altro caso d'uso, chiami un proxy che si trova nella stessa organizzazione e nello stesso ambiente di quello da cui chiami. Ad esempio, questo potrebbe essere utile quando hai un proxy che offre alcune discrete funzionalità di basso livello che verranno utilizzate da uno o più altri proxy. Ad esempio, un proxy che espone le operazioni di creazione/lettura/aggiornamento/eliminazione con un datastore di backend potrebbe essere il proxy di destinazione per più altri proxy che espongono i dati ai client.

Il criterio supporta le richieste su HTTP e HTTPS.

Campioni

Chiamata locale a un proxy interno

<LocalTargetConnection>
    <APIProxy>data-manager</APIProxy>
    <ProxyEndpoint>default</ProxyEndpoint>
</LocalTargetConnection>

In questo esempio viene creato un callout per un proxy API locale (ovvero nella stessa organizzazione e nello stesso ambiente) denominato data-manager, specificando il relativo endpoint proxy il cui nome è default.

URL come variabile

<HTTPTargetConnection>
    <URL>http://example.com/{request.myResourcePath}</URL>
</HTTPTargetConnection>

In questo esempio viene utilizzata una variabile nell'URL per compilare in modo dinamico l'URL del target. La parte del protocollo dell'URL, http://, non può essere specificata da una variabile. Inoltre, devi utilizzare variabili separate per la parte relativa al dominio dell'URL e per il resto dell'URL.

Geocodifica di Google / definisci richiesta

<ServiceCallout name="ServiceCallout-GeocodingRequest1">
    <DisplayName>Inline request message</DisplayName>
    <Request variable="authenticationRequest">
      <Set>
        <QueryParams>
          <QueryParam name="address">{request.queryparam.postalcode}</QueryParam>
          <QueryParam name="region">{request.queryparam.country}</QueryParam>
          <QueryParam name="sensor">false</QueryParam>
        </QueryParams>
      </Set>
    </Request>
    <Response>GeocodingResponse</Response>
    <Timeout>30000</Timeout>
    <HTTPTargetConnection>
      <URL>https://maps.googleapis.com/maps/api/geocode/json</URL>
    </HTTPTargetConnection>
</ServiceCallout>

Anziché utilizzare un criterio come il criterioAssignMessage per creare l'oggetto della richiesta, puoi definirlo direttamente nel criterio ServiceCallout. In questo esempio, il criterio ServiceCallout imposta i valori di tre parametri di ricerca passati al servizio esterno. Puoi creare un intero messaggio di richiesta nel criterio ServiceCallout che specifica un payload, un tipo di codifica come application/xml, intestazioni, parametri del modulo e così via.

Ecco un altro esempio in cui la richiesta viene effettuata prima di raggiungere le norme ServiceCallout.

<ServiceCallout name="ServiceCallout-GeocodingRequest2">
    <Request clearPayload="false" variable="GeocodingRequest"/>
    <Response>GeocodingResponse</Response>
    <Timeout>30000</Timeout>
    <HTTPTargetConnection>
      <URL>https://maps.googleapis.com/maps/api/geocode/json</URL>
    </HTTPTargetConnection>
</ServiceCallout>

I contenuti del messaggio di richiesta vengono estratti da una variabile denominata GeocodingRequest (che potrebbe essere compilata, ad esempio, da un criterioAssignMessage). Il messaggio di risposta viene assegnato alla variabile denominata GeocodingResponse, dove può essere analizzato da un criterio ExtractVariables o tramite codice personalizzato scritto in JavaScript o Java. Il criterio attende 30 secondi di risposta dall'API Google Geocoding prima del timeout.

Server target di chiamata

<ServiceCallout async="false" continueOnError="false" enabled="true" name="service-callout">
    <DisplayName>service-callout</DisplayName>
    <Properties/>
    <Request clearPayload="true" variable="myRequest">
        <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    </Request>
    <Response>myResponse</Response>
    <HTTPTargetConnection>
        <LoadBalancer>
            <Algorithm>RoundRobin</Algorithm>
            <Server name="httpbin"/>
            <Server name="yahoo"/>
        </LoadBalancer>
        <Path>/get</Path>
    </HTTPTargetConnection>
</ServiceCallout>

Questo criterio utilizza l'attributo LoadBalancer per chiamare i server di destinazione ed eseguire il bilanciamento del carico tra di essi. In questo esempio, il carico è distribuito tra due server di destinazione denominati httpbin e yahoo. Per informazioni sulla configurazione dei server di destinazione per il proxy e del bilanciamento del carico, consulta Bilanciamento del carico tra i server di backend.

Informazioni sulle norme relative a ServiceCallout

Esistono molti scenari in cui è possibile utilizzare un criterio ServiceCallout nel proxy API. Ad esempio, puoi configurare un proxy API per effettuare chiamate a un servizio esterno al fine di fornire dati di geolocalizzazione, recensioni dei clienti, articoli del catalogo di un partner e così via.

In genere, un callout viene utilizzato con altri due criteri: AssignMessage ed ExtractVariables.

  • Request: AssignMessage compila il messaggio di richiesta inviato al servizio remoto.

  • Risposta: ExtractVariables analizza la risposta ed estrae contenuti specifici.

La tipica composizione delle norme ServiceCallout prevede:

  1. CriterioAssignMessage: crea un messaggio di richiesta, compila le intestazioni HTTP e parametri di ricerca, imposta il verbo HTTP e così via.

  2. Criterio ServiceCallout: fa riferimento a un messaggio creato dal criterioAssignMessage, definisce un URL di destinazione per la chiamata esterna e un nome per l'oggetto di risposta restituito dal servizio di destinazione.

    Per prestazioni migliori, puoi anche memorizzare nella cache le risposte ServiceCallout, come descritto in Come posso archiviare i risultati del criterio ServiceCallout nella cache? e, in un secondo momento, recuperarlo dalla cache?

  3. Criterio ExtractVariables: in genere definisce un'espressione JSONPath o XPath che analizza il messaggio generato da ServiceCallout. Il criterio quindi imposta variabili contenenti i valori analizzati dalla risposta ServiceCallout.

Gestione personalizzata degli errori

Riferimento elemento

Di seguito sono riportati gli elementi e gli attributi che puoi configurare su questo criterio:

<ServiceCallout async="false" continueOnError="false" enabled="true" name="Service-Callout-1">
    <DisplayName>Custom label used in UI</DisplayName>
    <Request clearPayload="true" variable="myRequest">
        <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
        <Remove>
            <StatusCode/>
            <Path/>
            <Version/>
            <Verb/>
         </Remove>
         <Copy>
            <StatusCode/>
            <Path/>
            <Version/>
            <Verb/>
        </Copy>
        <Add>
            <Headers/>
            <QueryParams/>
            <FormParams/>
        </Add>
        <Set>
            <Headers/>
            <QueryParams/>
            <FormParams/>
            <Payload/>
            <StatusCode/>
            <Path/>
            <Version/>
            <Verb/>
        </Set>
    </Request>
    <Response>calloutResponse</Response>
    <Timeout>30000</Timeout>
    <HTTPTargetConnection>
        <URL>http://example.com</URL>
        <LoadBalancer/>
        <SSLInfo/>
        <Properties/>
        <Authentication>
          <HeaderName ref="{variable}">STRING</HeaderName>
          <GoogleAccessToken>
            <Scopes>
              <Scope>https://www.googleapis.com/auth/cloud-platform</Scope>
            </Scopes>
            <LifetimeInSeconds ref="{variable}">3600</LifetimeInSeconds>
          </GoogleAccessToken>
        </Authentication>
        <Authentication>
          <HeaderName ref="{variable}">STRING</HeaderName>
          <GoogleIDToken>
            <Audience ref="{variable}" useTargetUrl="BOOLEAN">{hostname}</Audience>
            <IncludeEmail ref="{variable}">true</IncludeEmail>
          </GoogleIDToken>
        </Authentication>
    </HTTPTargetConnection>
    <LocalTargetConnection>
        <APIProxy/>
        <ProxyEndpoint/>
        <Path/>
    </LocalTargetConnection>
</ServiceCallout>

Attributi <ServiceCallout>

<ServiceCallout async="false" continueOnError="false" enabled="true" name="Service-Callout-1">

La tabella seguente descrive gli attributi comuni a tutti gli elementi principali dei criteri:

Attributo Descrizione Predefinito Presenza
name

Il nome interno della norma. Il valore dell'attributo name può contenere lettere, numeri, spazi, trattini, trattini bassi e punti. Questo valore non può superare i 255 caratteri.

Facoltativamente, utilizza l'elemento <DisplayName> per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso in linguaggio naturale.

 N/A Obbligatorio
continueOnError

Impostalo su false per restituire un errore in caso di errore di un criterio. Questo è il comportamento previsto per la maggior parte dei criteri.

Imposta su true per fare in modo che l'esecuzione del flusso continui anche in caso di errore di un criterio. Vedi anche:

 false Facoltativo
enabled

Imposta il criterio su true per applicare il criterio.

Impostala su false per disattivare il criterio. Il criterio non verrà applicato anche se rimane associato a un flusso.

 true Facoltativo
async

Questo attributo è obsoleto.

 false Deprecata

Elemento <DisplayName>

Utilizzalo in aggiunta all'attributo name per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso in linguaggio naturale.

<DisplayName>Policy Display Name</DisplayName>
Predefinito

N/A

Se ometti questo elemento, viene utilizzato il valore dell'attributo name del criterio.
Presenza Facoltativo
Tipo Stringa

Elemento <Request>

Specifica la variabile contenente il messaggio di richiesta che viene inviato dal proxy API all'altro servizio. La variabile può essere creata da un criterio precedente nel flusso oppure puoi crearla in linea nel criterio ServiceCallout.

<Request clearPayload="true" variable="myRequest">
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
    <Remove>
        <StatusCode/>
        <Path/>
        <Version/>
        <Verb/>
    </Remove>
    <Copy>
        <StatusCode/>
        <Path/>
        <Version/>
        <Verb/>
    </Copy>
    <Add>
        <Headers/>
        <QueryParams/>
        <FormParams/>
    </Add>
    <Set>
        <Headers/>
        <QueryParams/>
        <FormParams/>
        <Payload/>
        <StatusCode/>
        <Path/>
        <Version/>
        <Verb/>
    </Set>
</Request>

La sintassi dei tag <Remove>, <Copy>, <Add> e <Set> è la stessa del criterioAssignMessage.

Il criterio restituisce un errore se il messaggio di richiesta non può essere risolto o se è di un tipo di messaggio di richiesta non valido.

Nell'esempio più semplice, passi una variabile contenente il messaggio di richiesta che è stato compilato in precedenza nel flusso del proxy API:

<Request clearPayload="true" variable="myRequest"/>

In alternativa, puoi compilare il messaggio di richiesta inviato al servizio esterno nel criterio ServiceCallout stesso:

<Request>
  <Set>
    <Headers>
      <Header name="Accept">application/json</Header>
    </Headers>
    <Verb>POST</Verb>
    <Payload contentType="application/json">{"message":"my test message"}</Payload>
  </Set>
  <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
</Request>
Predefinito Se ometti l'elemento Request o uno qualsiasi dei suoi attributi, Apigee assegna i seguenti valori predefiniti:

<Request clearPayload="true" variables="servicecallout.request"/>

Esaminiamo il significato di questi valori predefiniti. Innanzitutto, clearPayload=true significa che ogni volta in esecuzione il criterio ServiceCallout viene creato un nuovo oggetto di richiesta. Ciò significa che la richiesta e il percorso dell'URI della richiesta non vengono mai riutilizzati. Il secondo, il nome della variabile predefinito, servicecallout.request, è un nome riservato che viene assegnato alla richiesta se non fornisci un nome.

È importante conoscere questo nome predefinito se utilizzi il mascheramento dei dati. Se ometti il nome della variabile, devi aggiungere servicecallout.request alla configurazione della maschera. Ad esempio, se vuoi mascherare l'intestazione Autorizzazione in modo che non venga visualizzata nelle sessioni di debug, devi aggiungere quanto segue alla configurazione di mascheramento per acquisire il nome predefinito:

servicecallout.request.header.Authorization.
Presenza Facoltativo.
Tipo N/A

Attributi

Attributo Descrizione Predefinita Presenza
variabile

Nome della variabile che conterrà il messaggio di richiesta.

 servicecallout.request Facoltativo
clearPayload

Se true, la variabile contenente il messaggio di richiesta viene cancellata dopo l'invio della richiesta alla destinazione HTTP per liberare la memoria utilizzata dal messaggio di richiesta.

Imposta l'opzione clearPayload su false solo se il messaggio di richiesta è obbligatorio dopo l'esecuzione di ServiceCallout.

 true Facoltativo

Elemento <Request>/<IgnoraUnresolvedVariables>

Se impostato su true, il criterio ignora eventuali errori relativi alle variabili non risolte presenti nella richiesta.

<Request clearPayload="true" variable="myRequest">
    <IgnoreUnresolvedVariables>false</IgnoreUnresolvedVariables>
</Request>
Predefinito false
Presenza Facoltativo
Tipo Booleano

Elemento <Response>

Includi questo elemento quando la logica del proxy API richiede la risposta dalla chiamata remota per un'ulteriore elaborazione.

Quando è presente, questo elemento specifica il nome della variabile che conterrà il messaggio di risposta ricevuto dal servizio esterno. La risposta dal target viene assegnata alla variabile solo quando l'intera risposta viene letta correttamente dal criterio. Se per qualsiasi motivo la chiamata remota non va a buon fine, il criterio restituisce un errore.

Se questo elemento viene omesso, il proxy API non attende una risposta; l'esecuzione del flusso proxy API continua con i passaggi del flusso successivi. Inoltre, per sottolineare l'ovvio, in assenza dell'elemento Response, la risposta dalla destinazione non è disponibile per l'elaborazione nei passaggi successivi e il flusso di proxy non può rilevare un errore nella chiamata remota. Un uso comune per omettere l'elemento Response quando si utilizza ServiceCallout: per registrare i messaggi in un sistema esterno.

 <Response>calloutResponse</Response>
Predefinito NA
Presenza Facoltativo
Tipo String

Elemento <Timeout>

Il tempo in millisecondi durante il quale il criterio ServiceCallout attende una risposta dal target. Non puoi impostare questo valore in modo dinamico in fase di runtime. Se ServiceCallout raggiunge un timeout, viene restituito un HTTP 500, il criterio ha esito negativo e il proxy API passa allo stato di errore, come descritto in Gestione degli errori.

<Timeout>30000</Timeout>
Predefinito 55.000 millisecondi (55 secondi), l'impostazione di timeout HTTP predefinita per Apigee
Presenza Facoltativo
Tipo Integer

Elemento <HTTPTargetConnection>

Fornisce dettagli sul trasporto come URL, TLS/SSL e proprietà HTTP. Consulta il riferimento per la configurazione di <TargetEndpoint>.

<HTTPTargetConnection>
    <URL>http://example.com</URL>
    <LoadBalancer/>
    <SSLInfo/>
    <Properties/>
</HTTPTargetConnection>
Predefinito N/A
Presenza Obbligatorio
Tipo N/A

Elemento <HTTPTargetConnection>/<Authentication>

Genera token Google OAuth 2.0 o OpenID Connect emessi da Google per effettuare chiamate autenticate ai servizi Google e ai servizi personalizzati in esecuzione su determinati prodotti Google Cloud, come Cloud Functions e Cloud Run. L'utilizzo di questo elemento richiede i passaggi di configurazione e deployment descritti in Utilizzare l'autenticazione Google. Con una configurazione corretta, il criterio crea un token di autenticazione per te e lo aggiunge alla richiesta di servizio.

Gli elementi secondari GoogleAccessToken e GoogleIDToken ti consentono di configurare il criterio per generare token Google OAuth o OpenID Connect. Devi scegliere uno di questi elementi secondari a seconda del tipo di servizio che vuoi chiamare.

Il criterio ServiceCallout supporta solo le chiamate a servizi basati su HTTP.

Predefinito N/A
Obbligatorio? Facoltativo.
Tipo Tipo complesso
Elemento principale <HTTPTargetConnection>
Elementi secondari <HeaderName>
<GoogleAccessToken>
<GoogleIDToken>

L'elemento Authentication utilizza la seguente sintassi:

Sintassi

<ServiceCallout>
...
  <HTTPTargetConnection>
    <Authentication>
      <HeaderName ref="FLOW_VARIABLE">STRING</HeaderName>
      <GoogleAccessToken>
        <Scopes>
          <Scope>SCOPE</Scope>
          ...
        </Scopes>
        <!-- NOTE: The default value for LifetimeInSeconds is 3600. Change the default only
        if you want to limit the risk of leaked access tokens or improve performance. -->
        <LifetimeInSeconds ref="{variable}">INTEGER</LifetimeInSeconds>
      </GoogleAccessToken>

    --OR--
      <HeaderName ref="FLOW_VARIABLE">STRING</HeaderName>
      <GoogleIDToken>
        <Audience ref="{variable}" useTargetUrl="BOOLEAN">STRING</Audience>
        <IncludeEmail ref="{variable}">BOOLEAN</IncludeEmail>
      </GoogleIDToken>
    </Authentication>
  </HTTPTargetConnection>
</ServiceCallout>

Utilizzo di GoogleAccessToken

Nell'esempio seguente viene mostrato l'elemento GoogleAccessToken:

<Authentication>
  <GoogleAccessToken>
    <Scopes>
      <Scope>https://www.googleapis.com/auth/cloud-platform</Scope>
    </Scopes>
  </GoogleAccessToken>
</Authentication>

Utilizzo di GoogleIDToken

Nell'esempio seguente viene mostrato l'elemento GoogleIDToken:

<Authentication>
  <GoogleIDToken>
      <Audience>https://httpserver0-bar.run.app</Audience>
      <IncludeEmail>false</IncludeEmail>
  </GoogleIDToken>
</Authentication>

Utilizzo di HeaderName

Nell'esempio seguente viene mostrato l'elemento HeaderName:

  <Authentication>
    <HeaderName>X-Serverless-Authorization</HeaderName>
    <GoogleAccessToken>
      <Scopes>
        <Scope>"https://www.googleapis.com/auth/cloud-platform"</Scope>
      </Scopes>
    </GoogleAccessToken>
  </Authentication>

Utilizzo di LifetimeInSeconds

Nell'esempio seguente viene mostrato l'elemento HeaderName:

  <Authentication>
    <GoogleAccessToken>
      <Scopes>
        <Scope>"https://www.googleapis.com/auth/cloud-platform"</Scope>
      </Scopes>
      <LifetimeInSeconds ref="variable">3600</LifetimeInSeconds>
    </GoogleAccessToken>
  </Authentication>

Attributi

Nessuno.

Elemento secondario HeaderName

Per impostazione predefinita, quando è presente una configurazione di Authentication, Apigee genera un token di connessione e lo inserisce nell'intestazione Authorization del messaggio inviato al sistema di destinazione. L'elemento HeaderName consente di specificare il nome di un'intestazione diversa per contenere il token di connessione. Questa funzionalità è particolarmente utile quando la destinazione è un servizio Cloud Run che utilizza l'intestazione X-Serverless-Authorization. L'intestazione Authorization, se presente, non viene modificata e viene inviata anche nella richiesta.

Predefinito N/A
Obbligatorio? No
Tipo String
Elemento principale <Authentication>
Elementi secondari Nessuna

L'elemento HeaderName utilizza la seguente sintassi:

Sintassi

<ServiceCallout>
...
  <Authentication>
    <HeaderName ref="FLOW_VARIABLE">STRING</HeaderName>
    <GoogleAccessToken>
      ...
    </GoogleAccessToken>
  </Authentication>
  ...
</ServiceCallout>

Con stringa statica

In questo esempio, il token di connessione generato viene aggiunto, per impostazione predefinita, a un'intestazione denominata X-Serverless-Authorization che viene inviata al sistema di destinazione. L'intestazione Authorization, se presente, non viene modificata e viene inviata anche nella richiesta.

<Authentication>
  <HeaderName>X-Serverless-Authorization</HeaderName>
  <GoogleAccessToken>
    <Scopes>
      <Scope>https://www.googleapis.com/auth/cloud-platform</Scope>
    </Scopes>
  </GoogleAccessToken>
</Authentication>

Con riferimento variabile

In questo esempio, il token di connessione generato viene aggiunto, per impostazione predefinita, a un'intestazione denominata X-Serverless-Authorization che viene inviata al sistema di destinazione. Se my-variable contiene un valore, viene utilizzato questo valore al posto della stringa predefinita. L'intestazione Authorization, se presente, non viene modificata e viene inviata anche nella richiesta.

<Authentication>
  <HeaderName ref='my-variable'>X-Serverless-Authorization</HeaderName>
  <GoogleAccessToken>
    <Scopes>
      <Scope>https://www.googleapis.com/auth/cloud-platform</Scope>
    </Scopes>
  </GoogleAccessToken>
</Authentication>

Elemento secondario GoogleAccessToken

Genera token Google OAuth 2.0 per effettuare chiamate autenticate ai servizi Google. I token OAuth di Google possono essere utilizzati per chiamare molti tipi di servizi Google, ad esempio Cloud Logging e Secret Manager.

Predefinito N/A
Obbligatorio? Deve essere presente l'elemento secondario GoogleAccessToken o GoogleIDToken.
Tipo String
Elemento principale <Authentication>
Elementi secondari <Scopes>
<LifetimeInSeconds>

L'elemento GoogleAccessToken utilizza la seguente sintassi:

Sintassi

<ServiceCallout>
...
  <Authentication>
    <GoogleAccessToken>
      <Scopes>
        <Scope>SCOPE_1</Scope>
        ...
      </Scopes>
      <!-- NOTE: The default value for LifetimeInSeconds is 3600. We do not recommend changing
      the default unless you want to limit the risk of leaked access tokens or improve performance. -->
      <LifetimeInSeconds ref="FLOW_VARIABLE">INTEGER</LifetimeInSeconds>
    </GoogleAccessToken>
  </Authentication>
  ...
</ServiceCallout>

Esempio 1

Nell'esempio seguente viene mostrato l'elemento GoogleAccessToken:

<Authentication>
  <GoogleAccessToken>
    <Scopes>
      <Scope>https://www.googleapis.com/auth/cloud-platform</Scope>
    </Scopes>
  </GoogleAccessToken>
</Authentication>

Esempio 2

L'esempio seguente mostra come connettersi a Secret Manager per recuperare un secret utilizzando il criterio ServiceCallout. 

<ServiceCallout name="ServiceCallout-sm">
  <Response>SecretManagerResponse</Response>
  <Timeout>30000</Timeout>
  <HTTPTargetConnection>
    <Authentication>
      <GoogleAccessToken>
        <Scopes>
          <Scope>https://www.googleapis.com/auth/cloud-platform</Scope>
        </Scopes>
      </GoogleAccessToken>
    </Authentication>
    <URL>
      https://secretmanager.googleapis.com/v1/projects/project-id/secrets/secret-id
    </URL>
  </HTTPTargetConnection>
</ServiceCallout>

Esempio 3

L'esempio seguente mostra come eseguire un callout a Cloud dal criterio ServiceCallout. 

<ServiceCallout name="ServiceCallout-CloudRun">
  <Response>CloudRunResponse</Response>
  <Timeout>30000</Timeout>
  <HTTPTargetConnection>
    <Authentication>
      <GoogleIDToken>
        <Audience>https://cloudrun-hostname.a.run.app/test</Audience>
      </GoogleIDToken>
    </Authentication>
    <URL>https://cloudrun-hostname.a.run.app/test</URL>
  </HTTPTargetConnection>
</ServiceCallout>

Elemento secondario degli ambiti

Identifica gli ambiti da includere nel token di accesso OAuth 2.0. Per maggiori informazioni, consulta Ambiti OAuth 2.0 per le API di Google. Puoi aggiungere uno o più elementi secondari <Scope> sotto questo elemento.

Predefinito N/A
Obbligatorio? Obbligatorio
Tipo String
Elemento principale <GoogleAccessToken>
Elementi secondari <Scope>

Elemento secondario ambito

Specifica un ambito valido dell'API di Google. Per maggiori informazioni, consulta Ambiti OAuth 2.0 per le API di Google.

Predefinito N/A
Obbligatorio? Almeno un valore è obbligatorio.
Tipo String
Elemento principale <Scopes>
Elementi secondari Nessuno.

Elemento secondario LifetimeInSeconds

Specifica la durata in secondi del token di accesso.

Predefinito 3600
Obbligatorio? Facoltativo
Tipo Integer
Elemento principale <GoogleAccessToken>
Elementi secondari Nessuno.

Elemento secondario GoogleIDToken

Genera token OpenID Connect emessi da Google per effettuare chiamate autenticate ai servizi Google.

Predefinito N/A
Obbligatorio? Deve essere presente l'elemento secondario GoogleAccessToken o GoogleIDToken.
Tipo String
Elemento principale <Authentication>
Elementi secondari <Audience>
<IncludeEmail>

L'elemento GoogleIDToken utilizza la seguente sintassi:

Sintassi

<ServiceCallout>
...
  <Authentication>
    <GoogleIDToken>
        <Audience ref="{variable}" useTargetUrl="BOOLEAN">STRING</Audience>
        <IncludeEmail ref="{variable}">BOOLEAN</IncludeEmail>
    </GoogleIDToken>
  </Authentication>
</ServiceCallout>

Esempio 1

Nell'esempio seguente viene mostrato l'elemento GoogleIDToken:

<Authentication>
  <GoogleIDToken>
      <Audience>https://httpserver0-bar.run.app</Audience>
      <IncludeEmail>true</IncludeEmail>
  </GoogleIDToken>
</Authentication>

Elemento secondario del segmento di pubblico

Il pubblico per il token di autenticazione generato, ad esempio l'API o l'account a cui il token concede l'accesso.

Se il valore Audience è vuoto o se la variabile ref non si risolve in un valore valido e useTargetUrl è true, l'URL del target (esclusi eventuali parametri di ricerca) viene utilizzato come segmento di pubblico. Per impostazione predefinita, il valore di useTargetUrl è false. 

<Audience>explicit-audience-value-here</Audience>

or:

<Audience ref='variable-name-here'/>

or:

<Audience ref='variable-name-here' useTargetUrl='true'/>

or:

<Audience useTargetUrl='true'/>
Predefinito N/A
Obbligatorio? Obbligatorio
Tipo String
Elemento principale <GoogleIDToken>
Elementi secondari Nessuno.

Elemento secondario IncludeEmail

Se impostato su true, il token di autenticazione generato conterrà le attestazioni dell'account di servizio email e email_verified.

Predefinito false
Obbligatorio? Facoltativo
Tipo Booleano
Elemento principale <GoogleIDToken>
Elementi secondari Nessuno.

Elemento <HTTPTargetConnection>/<URL>

L'URL del servizio chiamato:

<HTTPTargetConnection>
    <URL>http://example.com</URL>
</HTTPTargetConnection>

Puoi fornire una parte dell'URL in modo dinamico con una variabile. Tuttavia, la parte relativa al protocollo dell'URL, http:// di seguito, non può essere specificata da una variabile. Nel prossimo esempio viene utilizzata una variabile per specificare il valore di un parametro di query:

<URL>http://example.com/forecastrss?w=${request.header.woeid}</URL>

In alternativa, imposta una parte del percorso dell'URL con una variabile:

<URL>http://example.com/{request.resourcePath}?w=${request.header.woeid}</URL>

Se vuoi utilizzare una variabile per specificare il dominio e la porta dell'URL, utilizza una variabile solo per il dominio e la porta e una seconda variabile per qualsiasi altra parte dell'URL:

<URL>http://{request.dom_port}/{request.resourcePath}</URL>
Predefinito N/A
Presenza Obbligatorio
Tipo String

Elemento <HTTPTargetConnection>/<SSLInfo>

La configurazione TLS/SSL al servizio di backend. Per informazioni sulla configurazione TLS/SSL, consulta Opzioni per la configurazione di TLS e "Configurazione dell'endpoint di destinazione TLS/SSL" in Riferimento alla configurazione del proxy API.

<HTTPTargetConnection>
    <URL>https://example.com</URL>
    <SSLInfo>
        <Enabled>true</Enabled>
        <ClientAuthEnabled>true</ClientAuthEnabled>
        <KeyStore>ref://mykeystoreref</KeyStore>  ## Use of a reference is recommended
        <KeyAlias>myKey</KeyAlias>
        <TrustStore>myTruststore</TrustStore>
        <Ciphers/>
        <Protocols/>
    </SSLInfo>
</HTTPTargetConnection>
Predefinito N/A
Presenza Facoltativo
Tipo N/A

Elemento <HTTPTargetConnection>/<Properties>

Proprietà di trasporto HTTP al servizio di backend. Per maggiori informazioni, consulta Riferimento alle proprietà degli endpoint.

<HTTPTargetConnection>
    <URL>http://example.com</URL>
    <Properties>
        <Property name="allow.http10">true</Property>
        <Property name="request.retain.headers">
          User-Agent,Referer,Accept-Language
        </Property>
    </Properties>
</HTTPTargetConnection>
Predefinito N/A
Presenza Facoltativo
Tipo N/A

Elemento <HTTPTargetConnection>/<LoadBalancer>

Chiama uno o più server di destinazione ed esegui il bilanciamento del carico sui server. Vedi l'esempio Server di destinazione delle chiamate nella sezione Esempi. Vedi anche Bilanciamento del carico tra server di backend. Vedi anche Callout server/endpoint di destinazione che illustra i modi per chiamare i server di destinazione sia dal criterio ServiceCallout che dall'utilizzo delle regole di route.

<HTTPTargetConnection> <LoadBalancer> <Algorithm>RoundRobin</Algorithm> <Server name="httpbin"/> <Server name="yahoo"/> </LoadBalancer> <Path>/get</Path> </HTTPTargetConnection>
Predefinito N/A
Presenza Facoltativo
Tipo N/D

Elemento <LocalTargetConnection>

Specifica un proxy locale, ovvero un proxy nella stessa organizzazione e nello stesso ambiente, come destinazione dei callout di servizio.

Per specificare ulteriormente il target, utilizza gli elementi <APIProxy> e <ProxyEndpoint> oppure l'elemento <Path>.

<LocalTargetConnection>
   <APIProxy/>
   <ProxyEndpoint/>
   <Path/>
</LocalTargetConnection>
Predefinito N/A
Presenza Obbligatorio
Tipo N/A

Elemento <LocalTargetConnection>/<APIProxy>

Il nome di un proxy API che è la destinazione di una chiamata locale. Il proxy deve trovarsi nella stessa organizzazione e nello stesso ambiente del proxy che effettua la chiamata.

<LocalTargetConnection>
   <APIProxy>data-manager</APIProxy>
   <ProxyEndpoint>default</ProxyEndpoint>
</LocalTargetConnection>

Insieme all'elemento <APIProxy>, includi l'elemento <ProxyEndpoint> per specificare il nome dell'endpoint proxy che deve essere scelto come target per la chiamata.

<LocalTargetConnection>
   <APIProxy/>
   <ProxyEndpoint/>
</LocalTargetConnection>
Predefinito N/A
Presenza Obbligatorio
Tipo String

Elemento <LocalTargetConnection>/<ProxyEndpoint>

Il nome dell'endpoint proxy che deve essere la destinazione delle chiamate. Questo è un endpoint proxy nel proxy API specificato con l'elemento <APIProxy>.

<LocalTargetConnection>
   <APIProxy>data-manager</APIProxy>
   <ProxyEndpoint>default</ProxyEndpoint>
</LocalTargetConnection>
Predefinito N/A
Presenza Facoltativo
Tipo N/A

Elemento <LocalTargetConnection>/<Path>

Un percorso dell'endpoint scelto come target. L'endpoint deve fare riferimento a un proxy nella stessa organizzazione e nello stesso ambiente del proxy che effettua la chiamata.

Utilizza questa opzione anziché una coppia <APIProxy>/<ProxyEndpoint> quando non conosci il nome del proxy o non puoi fare affidamento su di esso. Il percorso potrebbe essere un obiettivo affidabile.

<LocalTargetConnection>
   <Path>/data-manager</Path>
</LocalTargetConnection>
Predefinito N/A
Presenza Facoltativo
Tipo N/A

Schema

Variabili di flusso

Le variabili di flusso consentono il comportamento dinamico di criteri e flussi in fase di runtime, in base a intestazioni HTTP, contenuto del messaggio o contesto del flusso. Le seguenti variabili di flusso predefinite sono disponibili dopo l'esecuzione del criterio ServiceCallout. Per ulteriori informazioni sulle variabili di flusso, consulta Riferimento per le variabili di flusso.

I callout di servizio hanno richieste e risposte proprie e puoi accedere a questi dati tramite variabili. Poiché il messaggio principale utilizza i prefissi di variabile request.* e response.*, utilizza i prefissi myrequest.* e calloutResponse.* (i valori predefiniti nella configurazione di ServiceCallout) per ricevere dati dei messaggi specifici per ServiceCallout. Il primo esempio nella tabella seguente mostra come ricevere le intestazioni HTTP in ServiceCallout.

Variabile Descrizione

Di seguito è riportato un esempio di come ottenere le intestazioni di richieste e risposte ServiceCallout simili a come ottenere le intestazioni dalla richiesta e dalla risposta principali.

calloutResponse.header.HeaderName

myRequest.header.HeaderName

dove calloutResponse è il nome della variabile per la risposta nel callout di servizio e myRequest è il nome della variabile per la richiesta. Ad esempio:

calloutResponse.header.Content-Length

restituisce l'intestazione Content-Length della risposta ServiceCallout.

Scope (Ambito): dall'inoltro di ServiceCallout
Type: String
Autorizzazione: Lettura/scrittura

Un'intestazione del messaggio nella richiesta o nella risposta ServiceCallout. Ad esempio, se il target del proxy API è http://example.com e il target ServiceCallout è http://mocktarget.apigee.net, queste variabili sono le intestazioni per il callout a http://mocktarget.apigee.net.
servicecallout.requesturi

Ambito: dall'inoltro della richiesta ServiceCallout
Type: String
Autorizzazione: Lettura/scrittura

L'URI TargetEndpoint per un criterio ServiceCallout. L'URI è l'URL TargetEndpoint senza il protocollo e la specifica del dominio.
servicecallout.{policy-name}.target.url

Ambito: dall'inoltro della richiesta ServiceCallout
Type: String
Autorizzazione: Lettura/scrittura

L'URL di destinazione per un ServiceCallout.

calloutResponse.content

dove calloutResponse è il <Response>nome della variabile nella configurazione ServiceCallout.

Ambito: dalla risposta ServiceCallout in avanti
Tipo: String
Autorizzazione: Lettura/Scrittura

Il corpo della risposta dal ServiceCallout.
servicecallout.{policy-name}.expectedcn

Ambito: dall'inoltro della richiesta ServiceCallout
Type: String
Autorizzazione: Lettura/scrittura

Il nome comune previsto del TargetEndpoint come definito in un criterio ServiceCallout. Ciò è significativo solo quando TargetEndpoint fa riferimento a un endpoint TLS/SSL.
servicecallout.{policy-name}.failed

Ambito: dall'inoltro della risposta ServiceCallout
Type: Boolean
Autorizzazione: Lettura/scrittura

Valore booleano che indica se il criterio ha avuto esito positivo, false o non riuscito, true.

Errori

Questa sezione descrive i codici e i messaggi di errore restituiti, nonché le variabili di errore impostate da Apigee quando questo criterio attiva un errore. È importante sapere se stai sviluppando regole di errore per gestire gli errori. Per saperne di più, consulta le sezioni Cosa devi sapere sugli errori dei criteri e Gestione degli errori.

Errori di runtime

Questi errori possono verificarsi quando il criterio viene eseguito.

Codice di errore Stato HTTP Causa Correggi
steps.servicecallout.ExecutionFailed 500

Questo errore può verificarsi quando:

  • Al criterio viene chiesto di gestire l'input con formato non valido o comunque non valido.
  • Il servizio di destinazione di backend restituisce uno stato di errore (per impostazione predefinita, 4xx o 5xx).
steps.servicecallout.RequestVariableNotMessageType 500 La variabile Request specificata nel criterio non è di tipo Message. Ad esempio, se si tratta di una stringa o di un altro tipo non di messaggio, verrà visualizzato questo errore.
steps.servicecallout.RequestVariableNotRequestMessageType 500 La variabile Request specificata nel criterio non è di tipo RequestMessage. Ad esempio, se si tratta di un tipo di risposta, visualizzerai questo errore.
googletoken.EmptyIDTokenAudience 500

<GoogleIDToken> è abilitato, ma useTargetUrl è impostato su false e non viene fornito alcun valore a <Audience> direttamente o tramite riferimento al momento dell'errore.
messaging.adaptors.http.filter.GoogleTokenGenerationFailure 500 Questo errore può verificarsi se il proxy API è configurato con l'elemento <Authentication>. Le cause possibili sono:
  • L'account di servizio di cui è stato eseguito il deployment con il proxy:
    • non esiste nel progetto
    • è stato disattivato
    • (Solo Apigee hybrid) non ha concesso il ruolo roles/iam.serviceAccountTokenCreator per l'account di servizio apigee-runtime.
  • L'API IAMCredentials è disabilitata nel progetto di origine dell'account di servizio apigee-runtime.
  • Viene utilizzato l'elemento <GoogleAccessToken> e vengono forniti uno o più ambiti non validi. Ad esempio, cerca errori di battitura o ambiti vuoti.

    • Solo per Apigee hybrid, controlla il log del container di runtime e cerca GoogleTokenGenerationFailure per trovare messaggi di errore più dettagliati che potrebbero aiutarti a eseguire il debug del problema.

    Errori di deployment

    Questi errori possono verificarsi quando esegui il deployment di un proxy contenente questo criterio.

    Nome errore Causa Correggi
    URLMissing L'elemento <URL> all'interno di <HTTPTargetConnection> manca o è vuoto.
    ConnectionInfoMissing Questo errore si verifica se il criterio non ha un elemento <HTTPTargetConnection> o <LocalTargetConnection>.
    InvalidTimeoutValue Questo errore si verifica se il valore di <Timeout> è negativo o pari a zero.
    FAILED_PRECONDITION Questo errore si verifica se l'account di servizio non è presente quando il proxy è configurato con il tag <Authentication>.

    Ad esempio: 

    Deployment of \"organizations/foo/apis/apiproxy/revisions/1\" requires a service
          account identity, but one was not provided with the request.
    PERMISSION_DENIED Questo errore si verifica se si verifica un problema di autorizzazione con l'account di servizio se il proxy è configurato con il tag <Authentication>. Possibili cause:
    • L'account di servizio non esiste.
    • L'account di servizio non è stato creato nello stesso progetto Google Cloud dell'organizzazione Apigee.
    • Il deployer dispone dell'autorizzazione iam.serviceAccounts.actAs sull'account di servizio. Per maggiori dettagli, vedi Informazioni sulle autorizzazioni per gli account di servizio.

    Variabili di errore

    Queste variabili vengono impostate quando si verifica un errore di runtime. Per maggiori informazioni, consulta la sezione Cosa devi sapere sugli errori relativi ai criteri.

    Variabili Dove Esempio
    fault.name="fault_name" fault_name è il nome dell'errore, come elencato nella precedente tabella Errori di runtime. Il nome dell'errore è l'ultima parte del codice di errore. fault.name = "RequestVariableNotMessageType"
    servicecallout.policy_name.failed policy_name è il nome specificato dall'utente del criterio che ha generato l'errore. servicecallout.SC-GetUserData.failed = true

    Esempio di risposta di errore

    {
   "fault":{
      "detail":{
         "errorcode":"steps.servicecallout.RequestVariableNotMessageType"
      },
      "faultstring":"ServiceCallout[ServiceCalloutGetMockResponse]:
            request variable data_str value is not of type Message"
   }
}

    Esempio di regola di errore

    <FaultRule name="RequestVariableNotMessageType">
    <Step>
        <Name>AM-RequestVariableNotMessageType</Name>
    </Step>
    <Condition>(fault.name = "RequestVariableNotMessageType")</Condition>
</FaultRule>

    Argomenti correlati