Criterio SetIntegrationRequest

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Panoramica

Il criterio SetIntegrationRequest ti consente di creare un oggetto richiesta per un'integrazione che vuoi eseguire. Nel criterio, devi configurare i dettagli del trigger API e parametri di input necessari per eseguire l'integrazione. Quando esegui il criterio SetIntegrationRequest, viene creato un oggetto request e salvato in una variabile di flusso. L'oggetto request contiene tutte le informazioni necessarie per eseguire l'integrazione. In questa fase, l'integrazione non è ancora stata eseguita. Per eseguire l'integrazione, devi chiamare il criterio IntegrationCallout o impostare un IntegrationEndpoint. Sia il criterio IntegrationCallout sia IntegrationEndpoint richiedono l'oggetto della richiesta per eseguire l'integrazione.

Questo criterio è un criterio estensibile e il suo utilizzo potrebbe comportare 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 Tipi di criteri.

<SetIntegrationRequest>

Specifica il criterio SetIntegrationRequest.

La seguente tabella fornisce una descrizione generale degli elementi secondari dell'elemento <SetIntegrationRequest>:

Il criterio SetIntegrationRequest utilizza la seguente sintassi:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<SetIntegrationRequest continueOnError="[true|false]" enabled="[true|false]" name="Set-Integration-Request">
  <DisplayName>POLICY_DISPLAY_NAME</DisplayName>
  <ProjectId ref="FLOW_VARIABLE_NAME">GOOGLE_CLOUD_PROJECT_ID</ProjectId>
  <IntegrationName ref="FLOW_VARIABLE_NAME">INTEGRATION_NAME</IntegrationName>
  <IntegrationRegion ref="FLOW_VARIABLE_NAME">INTEGRATION_REGION</IntegrationRegion>
  <ApiTrigger ref="FLOW_VARIABLE_NAME">API_TRIGGER_NAME</ApiTrigger>
  <ScheduleTime>PARAMETER_VALUE</ScheduleTime>
  <Parameters>
    <Parameter name="PARAMETER_NAME" type="PARAMETER_DATATYPE" ref="FLOW_VARIABLE_NAME">PARAMETER_VALUE</Parameter>
    <ParameterArray name="ARRAY_NAME" type="ARRAY_DATATYPE" ref="FLOW_VARIABLE_NAME>
      <Value ref="FLOW_VARIABLE_NAME>PARAMETER_VALUE</Value>
      <Value ref="FLOW_VARIABLE_NAME>PARAMETER_VALUE</Value>
      <Value ref="FLOW_VARIABLE_NAME>PARAMETER_VALUE</Value>
    </ParameterArray>
  </Parameters>
  <Request>FLOW_VARIABLE_NAME</Request>
</SetIntegrationRequest>

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<SetIntegrationRequest continueOnError="false" enabled="true" name="Set-Integration-Request">
  <DisplayName>Set Integration Request Policy</DisplayName>
  <ProjectId ref="my_projectid_var">apigee_staging_1</ProjectId>
  <IntegrationName ref="my_integration_ref">integration_1</IntegrationName>
  <IntegrationRegion ref="my_integration_ref">asia-east1</IntegrationRegion>
  <ApiTrigger ref="my_api_trigger_ref">API-Trigger-2</ApiTrigger>
  <ScheduleTime>2022-01-15T01:30:15Z</ScheduleTime>
  <Parameters>
    <Parameter name="my_str_param" type="string" ref="flow_var_1">someText</Parameter>
    <ParameterArray name="my_array_param" type="integer" ref="flow_var_2">
      <Value ref="flow_var_3">1</Value>
      <Value ref="flow_var_4">2</Value>
      <Value ref="flow_var_5">3</Value>
    </ParameterArray>
  </Parameters>
  <Request>my_request_var</Request>
</SetIntegrationRequest>

Questo elemento ha i seguenti attributi comuni a tutti i criteri:

Riferimento elemento secondario

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

<ProjectId>

Specifica il nome del progetto Google Cloud.

Apigee assegna il valore specificato per questo elemento alla variabile di flusso integration.project.id.

L'elemento <ProjectId> utilizza la seguente sintassi:

<ProjectId ref="FLOW_VARIABLE_NAME">GOOGLE_CLOUD_PROJECT_ID</ProjectId>

<ProjectId ref="my_projectid_var">apigee_staging_1</ProjectId>

Nella tabella seguente vengono descritti gli attributi di <ProjectId>:

<IntegrationName>

Specifica l'integrazione da eseguire.

Apigee assegna il valore specificato per questo elemento alla variabile di flusso integration.name.

Il nome dell'integrazione deve soddisfare i seguenti requisiti di denominazione:

• Deve iniziare e terminare con lettere o numeri.
• Non possono contenere spazi.
• Non può contenere due trattini o trattini bassi consecutivi.

L'elemento <IntegrationName> utilizza la seguente sintassi:

<IntegrationName ref="FLOW_VARIABLE_NAME">INTEGRATION_NAME</IntegrationName>

<IntegrationName ref="my_integration_ref">integration_1</IntegrationName>

La tabella seguente descrive gli attributi di <IntegrationName>:

<IntegrationRegion>

Specifica la regione in cui esiste l'integrazione.

In fase di runtime, Apigee assegna il valore dell'elemento alla variabile di flusso integration.region, crea un URL di destinazione basato sulla regione e archivia l'URL nella variabile di flusso integration.target.url.

L'URL di destinazione in base alla regione ha il seguente formato: https://integration.region-integrations.googleapis.com

La regione di integrazione deve essere supportata da Application Integration. Per informazioni sulle regioni supportate di Application Integration, vedi Regioni supportate.

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

<IntegrationRegion ref="FLOW_VARIABLE_NAME">INTEGRATION_REGION</IntegrationRegion>

<IntegrationRegion ref="my_integration_region_ref">asia-east1</IntegrationRegion>

Nella tabella seguente vengono descritti gli attributi di <IntegrationRegion>:

<ApiTrigger>

Specifica l'attivatore dell'API da eseguire.

Devi specificare il nome del trigger API nel formato api_trigger/API_TRIGGER_NAME.

Apigee assegna il valore specificato per questo elemento alla variabile di flusso integration.api.trigger.

Se hai specificato <IntegrationName>, viene eseguito solo l'attivatore API dell'integrazione. Tuttavia, se non hai specificato <IntegrationName>, tutte le integrazioni che in cui eseguire il trigger API specificato.

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

<ApiTrigger ref="FLOW_VARIABLE_NAME">API_TRIGGER_NAME</ApiTrigger>

<ApiTrigger ref="my_api_trigger_ref">api_trigger/API-Trigger-2</ApiTrigger>

Nella tabella seguente vengono descritti gli attributi di <ApiTrigger>:

<ScheduleTime>

Specifica il momento in cui deve essere eseguita l'integrazione.

Se l'ora è inferiore o uguale all'ora corrente, l'integrazione viene eseguita immediatamente. Devi specificare l'ora nel formato yyyy-mm-ddThh:mm:ssZ, dove Z è il fuso orario UTC. Ad esempio, se specifichi 2022-01-15T01:30:15Z, l'integrazione viene pianificata per l'esecuzione il 1-15-2022 alle 1:30:15 UTC. Puoi anche specificare il fuso orario utilizzando una differenza rispetto al fuso orario UTC. Ad esempio, se specifichi 2022-01-15T01:30:15-08:00, l'integrazione è pianificata per l'esecuzione il 15/01/2022 alle 01:30:15 PST. Per ulteriori informazioni sul formato dell'ora, consulta Rappresentazioni combinate di data e ora.

L'elemento <ScheduleTime> utilizza la seguente sintassi:

<ScheduleTime>PARAMETER_VALUE</ScheduleTime>

<ScheduleTime>2022-01-15T01:30:15Z</ScheduleTime>

<Parameters>

Specifica i parametri di input necessari per eseguire l'integrazione.

Puoi specificare singoli parametri o array di parametri.

• Per specificare un singolo parametro, utilizza l'elemento <Parameter>.
• Per specificare un array di parametri, utilizza l'elemento <ParameterArray>.

Nella tabella seguente vengono descritti gli attributi di <Parameters>:

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

<Parameters substitutionVariableChar="SUBSTITUTION_CHAR">
  <Parameter name="PARAMETER_NAME" type="PARAMETER_DATATYPE" ref="FLOW_VARIABLE_NAME" >PARAMETER_VALUE</Parameter>
  <Parameter name="PARAMETER_NAME" type="PARAMETER_DATATYPE">SUBSTITUTION_CHAR FLOW_VARIABLE_NAME SUBSTITUTION_CHAR</Parameter>
  <ParameterArray name="ARRAY_NAME" type="ARRAY_DATATYPE ref="FLOW_VARIABLE_NAME"">
    <Value>PARAMETER_VALUE</Value>
    <Value ref="FLOW_VARIABLE_NAME"/>
    <Value ref="FLOW_VARIABLE_NAME">PARAMETER_VALUE</Value>
  </ParameterArray>
</Parameters>

<Parameters substitutionVariableChar="#">
  <Parameter name="my_str_param" type="string" ref="flow_var_1">someText</Parameter>
  <Parameter name="strVar" type="string">#flowvar1#</Parameter>
  <ParameterArray name="my_array_param" type="integer" ref="flow_var_2">
    <Value>1</Value>
    <Value ref="flow_var_3"/>
    <Value ref="flow_var_4">3</Value>
  </ParameterArray>
</Parameters>

Apigee tratta gli elementi <Parameter> e <ParameterArray> vuoti come valori null. Per ad esempio dichiarazioni come <Parameter></Parameter> e <ParameterArray></ParameterArray> vengono trattate come null valori.

<Parameter>

Specifica un parametro di input.

Puoi specificare il valore parametro nei seguenti modi:

• <Parameter name="my_param" type="string">val</Parameter>: utilizza val come valore del parametro. Se val non è valido. Apigee segnala un'eccezione.
• <Parameter name="my_param" type=&quot;string&quot; ref="refval"/>: risolvere la variabile di flusso refval in fase di esecuzione e utilizzarne il valore. Apigee segnala un'eccezione se il valore refval risolto non è valido o se refval non è risolto.
• <Parameter name="my_param" type=&quot;string&quot; ref="refval">val</Parameter>: risolvi refval di una variabile di flusso in fase di runtime e utilizzarne il valore. Apigee segnala un'eccezione se il valore refval risolto non è valido. Se refval non si risolve, Apigee utilizza val come valore parametro.
• <Parameter name="my_param" type="json">{"name":"$#flowval#$"}</Parameter>: utilizza $#FLOW_VARIABLE_NAME#$ per passare i valori delle variabili di flusso come argomento del modello in Parametro. Apigee risolve la variabile di flusso flowval in fase di esecuzione e ne utilizza il valore. Viene segnalata un'eccezione se il valore flowval risolto non è valido.
• <Parameter name="my_param" type="json">{"name":"SUBSTITUTION_CHAR flowval SUBSTITUTION_CHAR"}</Parameter>: dove SUBSTITUTION_CHAR indica il valore specificato per l'attributo substitutionVariableChar dell'elemento principale <Parameters>. Apigee risolve il flusso di una variabile di flusso in fase di esecuzione e ne utilizza il valore. Viene segnalata un'eccezione se il valore flowval risolto non è valido.

L'elemento <Parameter> utilizza la seguente sintassi:

<Parameters substitutionVariableChar="SUBSTITUTION_CHAR">
  <Parameter name="PARAMETER_NAME" type="PARAMETER_DATATYPE">PARAMETER_VALUE</Parameter>
  <Parameter name="PARAMETER_NAME" type="PARAMETER_DATATYPE" ref="FLOW_VARIABLE_NAME"/>
  <Parameter name="PARAMETER_NAME" type="PARAMETER_DATATYPE" ref="FLOW_VARIABLE_NAME">PARAMETER_VALUE</Parameter>
  <Parameter name="PARAMETER_NAME" type="json">$#FLOW_VARIABLE_NAME#$</Parameter>
  <Parameter name="PARAMETER_NAME" type="PARAMETER_DATATYPE">SUBSTITUTION_CHAR FLOW_VARIABLE_NAME SUBSTITUTION_CHAR</Parameter>
</Parameters>

<Parameters>
  <Parameter name="my_str_param" type="string">someText</Parameter>
</Parameters>

<Parameters>
  <Parameter name="my_double_param" type="double" ref="flow_var"/>
</Parameters>

<Parameters>
  <Parameter name="my_int_param_1" type="integer" ref="flow_var_1">96</Parameter>
</Parameters>

<Parameters>
  <Parameter name="my_json_param_1" type="json" ref="flow_var_1">{name:"Apple", color:"Red"}</Parameter>
  <Parameter name="my_json_param_2" type="json">{name:"Banana", color:"Yellow"}</Parameter>
</Parameters>

  <Parameters>
    <Parameter name="template_json_param" type="json">{"name":"$#flow_var_1#$"}</Parameter>
</Parameters>
  

<Parameters substitutionVariableChar="#">
    <Parameter name="template_json_param" type="json">{"name":"#flow_var_1#"}</Parameter>
</Parameters>
  

Nella tabella seguente vengono descritti gli attributi di <Parameter>:

<ParameterArray>

Specifica un array di parametri di input.

L'elemento <Parameters> può avere più <ParameterArray> elementi al suo interno. Per un array di parametri, puoi impostare il valore degli elementi dell'array specificando il valore effettivo o una variabile di flusso nell'attributo ref. Se specifichi una variabile di flusso, gli elementi dell'array vengono impostati sul valore della variabile di flusso. Gli esempi in questa sezione descrivono i vari modi in cui puoi configurare l'elemento <ParameterArray>.

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

<Parameters>
  <ParameterArray name="ARRAY_NAME" type="ARRAY_DATATYPE" ref="FLOW_VARIABLE_NAME">
    <Value ref="FLOW_VARIABLE_NAME"/>
    <Value ref="FLOW_VARIABLE_NAME">PARAMETER_VALUE</Value>
    <Value>PARAMETER_VALUE</Value>
  </ParameterArray>
  <ParameterArray name="ARRAY_NAME" type="ARRAY_DATATYPE" ref="FLOW_VARIABLE_NAME"/>
  <ParameterArray name="ARRAY_NAME" type="ARRAY_DATATYPE">
    <Value ref="FLOW_VARIABLE_NAME"/>
    <Value ref="FLOW_VARIABLE_NAME">PARAMETER_VALUE</Value>
    <Value>PARAMETER_VALUE</Value>
  </ParameterArray>
<Parameters/>

<Parameters>
  <ParameterArray name="my_array_param" type="integer">
    <Value>1</Value>
    <Value>2</Value>
    <Value>3</Value>
  </ParameterArray>
<Parameters/>

<Parameters>
  <ParameterArray name="my_array_param" type="double">
    <Value ref="flow_var_1"/>
    <Value>3.0</Value>
  </ParameterArray>
<Parameters/>

<Parameters>
  <ParameterArray name="my_array_param" type="boolean" ref="flow_var_1">
    <Value>true</Value>
    <Value>false</Value>
    <Value>false</Value>
  </ParameterArray>
<Parameters/>

<Parameters>
  <ParameterArray name="my_array_param" type="json" ref="flow_var_1"/>
<Parameters/>

<Parameters>
  <ParameterArray name="my_array_param" type="string" ref="flow_var_1">
    <Value ref="flow_var_2"/>
    <Value>test_string</Value>
  </ParameterArray>
<Parameters/>

Nella tabella seguente vengono descritti gli attributi di <ParameterArray>:

<Value>

Specifica il valore di un elemento array.

Ogni elemento dell'array deve essere un elemento <Value> distinto. Puoi specificare il valore nei seguenti modi:

• <Value>val</Value>: utilizza val come valore dell'elemento. Se val non è valido. Apigee segnala un'eccezione.
• <Value ref="refval"/>: risoluzione della variabile di flusso refval in fase di esecuzione e utilizzarne il valore. Apigee segnala un'eccezione se il valore refval risolto non è valido o se refval non è risolto.
• <Value ref="refval">val</Value>: risolvi la variabile di flusso refval in fase di esecuzione e utilizza il relativo valore. Apigee genera un'eccezione se il valore refval risolto non è valido. Se refval non viene risolto, Apigee utilizza val come valore dell'elemento.
• <Value>val1 $#flowval#$</Value>: utilizza $#FLOW_VARIABLE_NAME#$ per passare i valori delle variabili di flusso come argomento del modello in Valore. Apigee risolve la variabile di flusso flowval in fase di esecuzione e ne utilizza il valore. Viene segnalata un'eccezione se il valore flowval risolto non è valido.

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

<ParameterArray name="ARRAY_NAME" type="ARRAY_DATATYPE" ref="FLOW_VARIABLE_NAME">
  <Value>PARAMETER_VALUE</Value>
  <Value ref="FLOW_VARIABLE_NAME"/>
  <Value ref="FLOW_VARIABLE_NAME">PARAMETER_VALUE</Value>
</ParameterArray>

<ParameterArray name="my_array_param" type="integer">
  <Value>1</Value>
  <Value>2</Value>
  <Value>3</Value>
</ParameterArray>

<ParameterArray name="my_array_param" type="string">
  <Value ref="flow_var_1"/>
  <Value ref="flow_var_2"/>
</ParameterArray>

<ParameterArray name="my_array_param" type="string">
   <Value ref="flow_var_1">string_1</Value>
   <Value ref="flow_var_2">string_2</Value>
</ParameterArray>

  <Parameters>
    <ParameterArray name="template_strArray_param" type="string">
    <Value>apple $#flow_var_1#$</Value>
    </ParameterArray>
  </Parameters>
  

Nella tabella seguente vengono descritti gli attributi di <Value>:

<Request>

Specifica il nome della variabile di flusso per salvare la richiesta.

Dopo l'esecuzione, il criterio crea un nuovo oggetto messaggio di richiesta, e lo salva nella variabile FLOW_VARIABLE_NAME, su cui puoi eseguire query per leggere la richiesta.

Se non specifichi un nome di variabile di flusso, il criterio salva la richiesta nel messaggio di richiesta, sostituendo eventualmente il messaggio di richiesta esistente.

L'elemento <Request> utilizza la seguente sintassi:

<Request>FLOW_VARIABLE_NAME</Request>

<Request>my_request_var</Request>

Codici di errore

Questa sezione descrive i codici di errore, i messaggi di errore e le variabili di errore impostate da Apigee quando questo criterio attiva un errore. Queste informazioni sono essenziali se stai 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.

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.

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 AlzaFault, consulta Confronto tra le regole di errore 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 degli edifici.

La tabella seguente descrive le variabili di errore specifiche di questo criterio.

Argomenti correlati

Per scoprire di più sulla funzionalità di integrazione delle applicazioni, consulta Panoramica di Application Integration