Criterio SetIntegrationRequest

Policy estensibile

Questa pagina si applica ad Apigee e Apigee hybrid.

Visualizza la documentazione di Apigee Edge.

Il criterio SetIntegrationRequest consente di creare un oggetto richiesta per un'integrazione che vuoi eseguire. Nella policy, devi configurare i dettagli del trigger API e i parametri di input necessari per eseguire l'integrazione. Quando esegui il criterio SetIntegrationRequest, viene creato un oggetto richiesta e salvato in una variabile di flusso. L'oggetto richiesta 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 che IntegrationEndpoint richiedono l'oggetto richiesta per eseguire l'integrazione.

Queste norme sono estendibili e il loro utilizzo potrebbe avere implicazioni in termini di costi o utilizzo, a seconda della licenza Apigee. Per informazioni sui tipi di policy e sulle implicazioni di utilizzo, consulta Tipi di policy.

Nota:

• Puoi eseguire solo le integrazioni che hanno un trigger API.
• Per eseguire un'integrazione, devi utilizzare il criterio SetIntegrationRequest insieme al criterio IntegrationCallout o all'endpoint di integrazione.

<SetIntegrationRequest>

Specifica il criterio SetIntegrationRequest.

Valore predefinito	N/D
Obbligatorio?	Obbligatorio
Tipo	Tipo complesso
Elemento principale	N/D
Elementi secondari	<ApiTrigger> <DisplayName> <IntegrationName> <IntegrationRegion> <Parameters> <ProjectId> <Request> <ScheduleTime>

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

Elemento secondario	Obbligatorio?	Descrizione
<ApiTrigger>	Obbligatorio	Nome del trigger API da chiamare nell'integrazione.
<DisplayName>	Facoltativo	Un nome personalizzato per il criterio.
<IntegrationName>	Facoltativo	Il nome dell'integrazione da eseguire.
<IntegrationRegion>	Obbligatorio	Nome della regione in cui esiste l'integrazione.
<Parameters>	Facoltativo	Parametri di input dell'integrazione.
<ProjectId>	Facoltativo	Nome del progetto Google Cloud che contiene l'integrazione che vuoi eseguire.
<Request>	Facoltativo	Il nome della variabile di flusso in cui salvare l'oggetto richiesta.
<ScheduleTime>	Facoltativo	L'ora in cui deve essere eseguita l'integrazione.

Il criterio SetIntegrationRequest utilizza la seguente sintassi:

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>

Esempio

L'esempio seguente mostra la definizione del criterio 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:

Attributo	Predefinito	Obbligatorio?	Descrizione
name	N/D	Obbligatorio	Il nome interno del criterio. Il valore dell'attributo name può contenere lettere, numeri, spazi, trattini, trattini bassi e punti. Questo valore non può superare i 255 caratteri. Se vuoi, utilizza l'elemento <DisplayName> per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso in linguaggio naturale.
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: Le regole di errore vengono attivate SOLO in uno stato di errore (informazioni su continueOnError) Gestione degli errori all'interno del flusso corrente
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 all'elemento secondario

Questa sezione descrive gli elementi secondari di <SetIntegrationRequest>.

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

<ProjectId>

Specifica il nome del progetto Google Cloud.

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

Valore predefinito	N/D
Obbligatorio?	Facoltativo
Tipo	Stringa
Elemento principale	<SetIntegrationRequest>
Elementi secondari	Nessuno

L'elemento <ProjectId> utilizza la seguente sintassi:

Sintassi

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

Esempio

Il seguente esempio configura la policy per utilizzare la variabile di flusso my_projectid_var per recuperare l'ID progetto e, se la variabile di flusso non viene risolta in fase di runtime, utilizza apigee_staging_1 come ID progetto:

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

La tabella seguente descrive gli attributi di <ProjectId>:

Attributo	Obbligatorio?	Tipo	Descrizione
ref	Facoltativo	Stringa	Specifica la variabile di flusso da cui Apigee deve leggere l'ID progetto Google Cloud. Puoi impostare l'elemento <ProjectId> in uno dei seguenti modi: <ProjectId>val</ProjectId>: utilizza val come ID progetto. <ProjectId ref="refval"/>: risolvi refval in modo dinamico per determinare l'ID progetto. Apigee segnala un'eccezione se l'ID progetto risolto non è valido o se refval non è risolto. <ProjectId ref="refval">val</ProjectId>: risolvi refval in modo dinamico per determinare l'ID progetto. Apigee segnala un'eccezione se l'ID progetto risolto non è valido. Se refval non viene risolto, utilizza val come ID progetto.

<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 può contenere spazi.
• Non può contenere due trattini o trattini bassi consecutivi.

Valore predefinito	N/D
Obbligatorio?	Facoltativo
Tipo	Stringa
Elemento principale	<SetIntegrationRequest>
Elementi secondari	Nessuno

L'elemento <IntegrationName> utilizza la seguente sintassi:

Sintassi

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

Esempio

Il seguente esempio configura la policy in modo che utilizzi la variabile di flusso my_integration_ref per recuperare il nome dell'integrazione e, se la variabile di flusso non viene risolta in fase di runtime, utilizzi integration_1 come nome dell'integrazione:

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

La tabella seguente descrive gli attributi di <IntegrationName>:

Attributo	Obbligatorio?	Tipo	Descrizione
ref	Facoltativo	Stringa	Specifica la variabile di flusso da cui Apigee deve leggere il nome dell'integrazione. Puoi impostare l'elemento <IntegrationName> in uno dei seguenti modi: <IntegrationName>val</IntegrationName>: utilizza val come nome dell'integrazione. <IntegrationName ref="refval"/>: risolvi refval in modo dinamico per determinare il nome dell'integrazione. Apigee segnala un'eccezione se il nome dell'integrazione risolto non è valido o se refval non è risolto. <IntegrationName ref="refval">val</IntegrationName>: risolvi refval in modo dinamico per determinare il nome dell'integrazione. Apigee segnala un'eccezione se il nome dell'integrazione risolto non è valido. Se refval non viene risolto, utilizza val come nome dell'integrazione.

<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 lo memorizza nella variabile di flusso integration.target.url.

L'URL di destinazione basato sulla 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, consulta Regioni supportate.

Valore predefinito	N/D
Obbligatorio?	Obbligatorio
Tipo	Stringa
Elemento principale	<SetIntegrationRequest>
Elementi secondari	Nessuno

L'elemento <IntegrationRegion> utilizza la seguente sintassi:

Sintassi

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

Esempio

L'esempio seguente configura la policy in modo che utilizzi la variabile di flusso my_integration_region_ref per recuperare la regione di integrazione e, se la variabile di flusso non viene risolta in fase di runtime, asia-east1 viene utilizzata come regione dell'integrazione:

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

La tabella seguente descrive gli attributi di <IntegrationRegion>:

Attributo	Obbligatorio?	Tipo	Descrizione
ref	Facoltativo	Stringa	Specifica la variabile di flusso da cui Apigee deve leggere la regione di integrazione. Puoi impostare l'elemento <IntegrationRegion> in uno dei seguenti modi: <IntegrationRegion>val</IntegrationRegion>: utilizza val come regione di integrazione. <IntegrationRegion ref="refval"/>: risolvi refval in modo dinamico per determinare la regione di integrazione. Apigee segnala un'eccezione se la regione di integrazione risolta non è valida o se refval non è risolto. <IntegrationRegion ref="refval">val</IntegrationRegion>: risolvi refval in modo dinamico per determinare la regione di integrazione. Apigee segnala un'eccezione se la regione di integrazione risolta non è valida. Se refval non viene risolto, utilizza val come regione di integrazione.

<ApiTrigger>

Specifica il trigger 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 il trigger API di questa integrazione. Tuttavia, se non hai specificato <IntegrationName>, vengono eseguite tutte le integrazioni che hanno il trigger API specificato.

Valore predefinito	N/D
Obbligatorio?	Obbligatorio
Tipo	Stringa
Elemento principale	<SetIntegrationRequest>
Elementi secondari	Nessuno

L'elemento <ApiTrigger> utilizza la seguente sintassi:

Sintassi

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

Esempio

Il seguente esempio configura la policy in modo da utilizzare la variabile di flusso my_api_trigger_ref per recuperare il nome del trigger API e, se la variabile di flusso non viene risolta in fase di runtime, utilizzare api_trigger/API-Trigger-2 come nome del trigger API:

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

La tabella seguente descrive gli attributi di <ApiTrigger>:

Attributo	Obbligatorio?	Tipo	Descrizione
ref	Facoltativo	Stringa	Specifica la variabile di flusso da cui Apigee deve leggere il nome del trigger API. Puoi impostare l'elemento <ApiTrigger> in uno dei seguenti modi: <ApiTrigger>val</ApiTrigger>: utilizza val come nome del trigger API. <ApiTrigger ref="refval"/>: risolvi refval in modo dinamico per determinare il nome del trigger. Apigee segnala un'eccezione se il nome del trigger API risolto non è valido o se refval non è risolto. <ApiTrigger ref="refval">val</ApiTrigger>: risolvi refval in modo dinamico per determinare il nome del trigger. Apigee segnala un'eccezione se il nome del trigger API risolto non è valido. Se refval non viene risolto, utilizza val come nome del trigger.

<ScheduleTime>

Specifica l'ora in cui deve essere eseguita l'integrazione.

Se l'ora è minore o uguale all'ora attuale, 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 è pianificata per l'esecuzione il 15/01/2022 alle 01:30:15 UTC. Puoi anche specificare il fuso orario utilizzando una differenza rispetto all'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 saperne di più sul formato dell'ora, vedi Rappresentazioni combinate di data e ora.

Nota:puoi programmare l'ora solo se esegui le integrazioni in modalità asincrona. Se esegui l'integrazione in modalità sincrona e specifichi un orario di pianificazione, l'esecuzione dell'integrazione non va a buon fine e riceverai un errore di runtime.

Valore predefinito	N/D
Obbligatorio?	Facoltativo
Tipo	Stringa
Elemento principale	<SetIntegrationRequest>
Elementi secondari	Nessuno

L'elemento <ScheduleTime> utilizza la seguente sintassi:

Sintassi

<ScheduleTime>PARAMETER_VALUE</ScheduleTime>

Esempio

Il seguente esempio pianifica l'esecuzione dell'integrazione alle ore 2022-01-15T01:30:15Z:

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

Valore predefinito	N/D
Obbligatorio?	Facoltativo
Tipo	Tipo complesso
Elemento principale	<SetIntegrationRequest>
Elementi secondari	<Parameter> <ParameterArray>

La tabella seguente descrive gli attributi di <Parameters>:

Attributo	Obbligatorio?	Tipo	Descrizione
substitutionVariableChar	Facoltativo	Char	Consente di impostare delimitatori personalizzati per passare i valori delle variabili di flusso come argomenti del modello nell'elemento secondario <Parameter>. Nota:substitutionVariableChar può passare argomenti del modello solo per i parametri di tipo di dati JSON o String e per gli array di parametri di tipo di dati String array.

L'elemento <Parameters> utilizza la seguente sintassi:

Sintassi

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

Esempio

L'esempio seguente inizializza il parametro my_str_param e l'array di parametri my_array_param:

<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. Ad esempio, le dichiarazioni come <Parameter></Parameter> e <ParameterArray></ParameterArray> vengono trattate come valori null.

Nota: se un parametro ha un valore JSON, assicurati che il JSON sia valido. Ad esempio, se il payload JSON contiene virgolette doppie ("), esegui l'escape di ogni virgoletta doppia con una barra rovesciata (\).

<Parameter>

Specifica un parametro di input.

Valore predefinito	N/D
Obbligatorio?	Facoltativo
Tipo	Stringa
Elemento principale	<Parameters>
Elementi secondari	Nessuno

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="string" ref="refval"/>: risolvi la variabile di flusso refval in fase di runtime e utilizza il relativo valore. Apigee segnala un'eccezione se il valore refval risolto non è valido o se refval non è risolto.
• <Parameter name="my_param" type="string" ref="refval">val</Parameter>: risolvi la variabile di flusso refval in fase di runtime e utilizza il relativo valore. Apigee segnala un'eccezione se il valore refval risolto non è valido. Se refval non viene risolto, 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 Parameter. Apigee risolve la variabile di flusso flowval in fase di runtime e ne utilizza il valore. Viene segnalata un'eccezione se il valore flowval risolto non è valido.
  Nota:puoi trasmettere argomenti del modello solo per i parametri di tipo di dati JSON o String e per gli array di parametri di tipo di dati array di stringhe.
  Avviso:gli argomenti del modello racchiusi tra { e } non vengono più identificati come variabili di flusso.
• <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 la variabile di flusso flowval in fase di runtime e ne utilizza il valore. Viene segnalata un'eccezione se il valore risolto di flowval non è valido.
  Nota:substitutionVariableChar può passare argomenti del modello solo per i parametri di tipo di dati JSON o String e per gli array di parametri di tipo di dati String array.
  Importante:ti consigliamo di aggiungere e aggiornare l'attributo substitutionVariableChar nell'elemento principale <Parameters> per tutti i delimitatori esistenti nelle norme relative alla richiesta di integrazione dell'insieme.

L'elemento <Parameter> utilizza la seguente sintassi:

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>

Esempio 1

L'esempio seguente dichiara il parametro my_str_param come stringa e imposta il valore su someText.

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

Esempio 2

L'esempio seguente dichiara il parametro my_double_param come double e assegna il valore della variabile di flusso flow_var al parametro.

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

Esempio 3

L'esempio seguente imposta il valore sul parametro intero my_int_param_1.

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

In questo esempio, se la variabile di flusso flow_var_1 viene risolta correttamente, my_int_param_1 viene impostato sul valore della variabile di flusso. Tuttavia, se flow_var_1 non viene risolto, my_int_param_1 è impostato su 96.

Esempio 4

Il seguente esempio imposta i valori per i parametri JSON my_json_param_1 e my_json_param_2.

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

In questo esempio, se la variabile di flusso flow_var_1 viene risolta correttamente, my_json_param_1 viene impostato sul valore della variabile di flusso flow_var_1. Tuttavia, se la risoluzione di flow_var_1 non riesce, my_json_param_1 è impostato su {name:"Apple", color:"Red"}. Il parametro my_json_param_2 è impostato su {name:"Banana", color:"Yellow"} perché non è specificato alcun attributo ref.

Esempio 5

L'esempio seguente imposta il valore del parametro JSON template_json_param utilizzando il valore della variabile di flusso passato nel modello predefinito.

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

In questo esempio, se la variabile di flusso flow_var_1 viene risolta correttamente, template_json_param viene impostato sul valore della variabile di flusso flow_var_1. Tuttavia, se flow_var_1 non riesce a risolvere il problema, Apigee genera un'eccezione.

Esempio 6

L'esempio seguente imposta il valore del parametro JSON template_json_param utilizzando l'attributo substitutionVariableChar.

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

In questo esempio, se la variabile di flusso flow_var_1 viene risolta correttamente, template_json_param viene impostato sul valore della variabile di flusso flow_var_1. Tuttavia, se flow_var_1 non riesce a risolvere il problema, Apigee genera un'eccezione.

La tabella seguente descrive gli attributi di <Parameter>:

Attributo	Obbligatorio?	Tipo	Descrizione
name	Obbligatorio	Stringa	Nome del parametro.
type	Obbligatorio	Stringa	Il tipo di dati del parametro. I tipi supportati sono integer, string, boolean, double e json.
ref	Facoltativo	Stringa	Specifica la variabile di flusso da cui Apigee deve leggere il valore parametro. Apigee utilizza i seguenti criteri per impostare il valore parametro: Se la variabile di flusso viene risolta in fase di runtime ed è valida, Apigee utilizza il valore della variabile di flusso. Se la variabile di flusso viene risolta in fase di runtime, ma non è valida, Apigee segnala un'eccezione. Se la variabile di flusso non viene risolta in fase di runtime, Apigee utilizza il valore dell'elemento <Parameter>. Se il valore dell'elemento non è valido, Apigee segnala un errore.

<ParameterArray>

Specifica un array di parametri di input.

Valore predefinito	N/D
Obbligatorio?	Facoltativo
Tipo	Tipo complesso
Elemento principale	<Parameters>
Elementi secondari	<Value>

L'elemento <Parameters> può contenere più elementi <ParameterArray>. 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>.

L'elemento <ParameterArray> utilizza la seguente sintassi:

Sintassi

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

Example-1

L'esempio seguente dichiara my_array_param come array di numeri interi e imposta il valore degli elementi dell'array su 1, 2 e 3:

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

Example-2

L'esempio seguente dichiara my_array_param come array double in cui:

• Il primo elemento è impostato sul valore della variabile di flusso flow_var_1.
• Il secondo elemento è impostato su 3.0.

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

Example-3

L'esempio seguente dichiara my_array_param come array booleano e lo imposta sul valore della variabile di flusso flow_var_1.

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

In questo esempio, se flow_var_1 viene risolto correttamente, my_array_param viene impostato sui valori dell'array flow_var_1. Tuttavia, se flow_var_1 non viene risolto, l'array my_array_param viene impostato sui valori degli elementi Value.

Example-4

L'esempio seguente dichiara my_array_param come array JSON e lo imposta sul valore della variabile di flusso flow_var_1.

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

In questo esempio, se flow_var_1 viene risolto correttamente, my_array_param viene impostato sui valori dell'array flow_var_1. Tuttavia, se flow_var_1 non viene risolto, Apigee segnala un'eccezione.

Example-5

L'esempio seguente dichiara my_array_param come array di stringhe e lo imposta sui valori della variabile di flusso flow_var_1.

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

In questo esempio, se flow_var_1 viene risolto correttamente, my_array_param viene impostato sui valori dell'array flow_var_1. Solo se flow_var_1 non viene risolto, my_array_param viene impostato sui valori specificati negli elementi <Value>.

La tabella seguente descrive gli attributi di <ParameterArray>:

Attributo	Obbligatorio?	Tipo	Descrizione
name	Obbligatorio	Stringa	Nome dell'array di parametri.
type	Obbligatorio	Stringa	Tipo di dati dell'array di parametri. I tipi supportati sono integer, string, boolean e double.
ref	Facoltativo	Stringa	Specifica la variabile di flusso da cui Apigee deve leggere i valori dell'array. Apigee utilizza i seguenti criteri per impostare il valore parametro: Se la variabile di flusso viene risolta in fase di runtime ed è valida, Apigee utilizza il valore della variabile di flusso. Se la variabile di flusso viene risolta in fase di runtime, ma non è valida, Apigee segnala un'eccezione. Se la variabile di flusso non viene risolta in fase di runtime, Apigee utilizza i valori specificati negli elementi <Value>.

<Value>

Specifica il valore di un elemento dell'array.

Valore predefinito	N/D
Obbligatorio?	Facoltativo
Tipo	Stringa
Elemento principale	<ParameterArray>
Elementi secondari	Nessuno

Ogni elemento dell'array deve essere un elemento <Value> separato. 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"/>: risolve la variabile di flusso refval in fase di runtime e utilizza il relativo 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 runtime e utilizza il relativo valore. Apigee segnala 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 trasmettere i valori delle variabili di flusso come argomento del modello in Value. Apigee risolve la variabile di flusso flowval in fase di runtime e ne utilizza il valore. Viene segnalata un'eccezione se il valore flowval risolto non è valido.
  Nota: puoi specificare gli argomenti del modello solo come valore per gli array di parametri di tipo stringa.
  Avviso:gli argomenti del modello racchiusi tra { e } non vengono più identificati come variabili di flusso.

L'elemento <Value> utilizza la seguente sintassi:

Sintassi

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

Esempio 1

L'esempio seguente dichiara my_array_param come array di parametri interi con i valori 1, 2 e 3:

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

Esempio 2

L'esempio seguente dichiara my_array_param come array di parametri stringa con valori delle variabili di flusso flow_var_1 e flow_var_2:

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

Esempio 3

L'esempio seguente dichiara my_array_param come array di parametri stringa:

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

In questo esempio, se la variabile di flusso viene risolta correttamente, il valore dell'elemento dell'array viene impostato sul valore della variabile di flusso flow_var_1. Tuttavia, se la risoluzione di flow_var_1 non riesce, il valore dell'elemento dell'array viene impostato su string_1.

Esempio 4

L'esempio seguente imposta il valore per il parametro array di stringhe template_strArray_param utilizzando il valore della variabile di flusso passato in un modello.

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

In questo esempio, se la variabile di flusso viene risolta correttamente, il valore dell'elemento dell'array viene impostato sul valore della variabile di flusso flow_var_1. Tuttavia, se flow_var_1 non viene risolto, Apigee genera un'eccezione.

La tabella seguente descrive gli attributi di <Value>:

Attributo	Obbligatorio?	Tipo	Descrizione
ref	Facoltativo	Stringa	Specifica la variabile di flusso da cui Apigee deve leggere il valore parametro. Apigee utilizza i seguenti criteri per impostare il valore parametro: Se la variabile di flusso viene risolta in fase di runtime ed è valida, Apigee utilizza il valore della variabile di flusso. Se la variabile di flusso viene risolta in fase di runtime, ma non è valida, Apigee segnala un'eccezione. Se la variabile di flusso non viene risolta in fase di runtime, Apigee utilizza il valore dell'elemento <Value>. Se il valore dell'elemento non è valido, Apigee segnala un errore.

Nota:l'elemento <Value> non può essere vuoto.

<Request>

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

Nota:se utilizzi un endpoint di integrazione anziché il criterio IntegrationCallout, non specificare l'elemento <Request> nel criterio SetIntegrationRequest.

Dopo l'esecuzione della policy, viene creato un nuovo oggetto request message e l'oggetto viene salvato nella variabile FLOW_VARIABLE_NAME, che puoi interrogare per leggere la richiesta.

Se non specifichi un nome di variabile di flusso, il criterio salva la richiesta nel messaggio di richiesta, sovrascrivendo il messaggio di richiesta esistente, se presente.

Valore predefinito	richiesta
Obbligatorio?	Facoltativo
Tipo	Stringa
Elemento principale	<SetIntegrationRequest>
Elementi secondari	Nessuno

L'elemento <Request> utilizza la seguente sintassi:

Sintassi

<Request>FLOW_VARIABLE_NAME</Request>

Esempio

L'esempio seguente salva l'oggetto richiesta nella variabile di flusso my_request_var:

<Request>my_request_var</Request>

Codici di errore

This section describes the fault codes, error messages, and the fault variables set by Apigee when this policy triggers an error. This information is essential if you are developing fault rules to handle faults. To learn more, see What you need to know about policy errors and Handling faults.

Runtime errors

These errors can occur when the policy executes.

Fault code	HTTP status	Cause
steps.setintegrationrequest.EmptyParameterArray	500	This error occurs when the <ParameterArray> element has the name and type attributes, but doesn't have the ref attribute or a <Value> element.
steps.setintegrationrequest.EmptyParameterArrayValue	500	This error occurs when the <Value> element is empty and the ref attribute is not set.
steps.setintegrationrequest.InvalidResolvedFlowVariable	500	This error occurs when the flow variable specified in the ref attribute of an element fails to resolve to a valid value. For the ProjectId, IntegrationName, or the ApiTrigger elements, this error occurs if the flow variable resolves to a null, an empty string, or an invalid data type. A valid value for these elements is as follows: ProjectId: See the naming requirements for Project ID in the Before you begin section. IntegrationName: See the naming requirements for the IntegrationName element. ApiTrigger: The name should start with api_trigger/. For the ParameterArray element, this error occurs if the flow variable resolves to an empty string.
steps.setintegrationrequest.MismatchedTypeAndResolvedRef	500	This error occurs when the flow variable specified in the ref attribute of the <Parameter> element resolves, but the flow variable value's data type doesn't match the data type specified in the type attribute.
steps.setintegrationrequest.MismatchedTypeAndResolvedRefOfParameterArray	500	This error occurs when the flow variable specified in the ref attribute of the <ParameterArray> element resolves, but the flow variable value's data type doesn't match with the data type specified in the type attribute.
steps.setintegrationrequest.MismatchedTypeAndResolvedRefOfParameterArrayValue	500	This error occurs when the flow variable specified in the ref attribute of the <Value> element resolves, but the flow variable value's data type doesn't match with the data type specified in the type attribute of its parent element (<ParameterArray>).
steps.setintegrationrequest.RequestVariableNotMessageType	500	This error occurs when the flow variable specified by the Request element is not of message type.
steps.setintegrationrequest.RequestVariableNotRequestMessageType	500	This error occurs when the flow variable specified by the Request element is not of Request message type.
steps.setintegrationrequest.UnresolvedVariable	500	This error occurs when Apigee can't resolve the flow variables specified in the <Parameter>, <ParameterArray>, or the <Value> elements.

Fault variables

Whenever there are execution errors in a policy, Apigee generates error messages. You can view these error messages in the error response. Many a time, system generated error messages might not be relevant in the context of your product. You might want to customize the error messages based on the type of error to make the messages more meaningful.

To customize the error messages, you can use either fault rules or the RaiseFault policy. For information about differences between fault rules and the RaiseFault policy, see FaultRules vs. the RaiseFault policy. You must check for conditions using the Condition element in both the fault rules and the RaiseFault policy. Apigee provides fault variables unique to each policy and the values of the fault variables are set when a policy triggers runtime errors. By using these variables, you can check for specific error conditions and take appropriate actions. For more information about checking error conditions, see Building conditions.

The following table describes the fault variables specific to this policy.

Variables	Where	Example
fault.name	The fault.name can match to any of the faults listed in the Runtime errors table. The fault name is the last part of the fault code.	fault.name Matches "UnresolvedVariable"
SetIntegrationRequest.POLICY_NAME.failed	POLICY_NAME is the user-specified name of the policy that threw the fault.	SetIntegrationRequest.set-integration-request-1.failed = true

For more information about policy errors, see What you need to know about policy errors.

Argomenti correlati

Se vuoi saperne di più sulla funzionalità Application Integration, consulta la panoramica di Application Integration.