Questa pagina si applica ad Apigee e Apigee hybrid.
Visualizza la documentazione di Apigee Edge.
Panoramica
Il criterio SetIntegrationRequest consente di creare un oggetto richiesta per un'integrazione che vuoi eseguire. Nel criterio, 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 di richiesta e lo salva in una variabile di flusso. L'oggetto richiesta contiene tutte le informazioni necessarie per eseguire l'integrazione. In questa fase, l'integrazione non viene ancora eseguita. Per eseguire l'integrazione, devi chiamare il criterio IntegrationCallout o impostare un IntegrationEndpoint. Sia il criterio IntegrationCallout che IntegrationEndpoint richiedono che l'oggetto richiesta esegua l'integrazione.
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 di utilizzo, consulta Tipi di criteri.
<SetIntegrationRequest>
Specifica il criterio SetIntegrationRequest.
Valore predefinito | N/A |
Obbligatorio? | Obbligatorio |
Tipo | Tipo complesso |
Elemento principale | N/A |
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 | Nome dell'integrazione da eseguire. |
<IntegrationRegion> |
Obbligatorio | Nome della regione in cui si trova l'integrazione. |
<Parameters> |
Facoltativo | Parametri di input dell'integrazione. |
<ProjectId> |
Facoltativo | Nome del progetto Google Cloud contenente l'integrazione che vuoi eseguire. |
<Request> |
Facoltativo | Nome della variabile di flusso per salvare l'oggetto della 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/A | Obbligatorio |
Il nome interno del criterio. Il valore dell'attributo Facoltativamente, utilizza l'elemento |
continueOnError |
falso | Facoltativo | Imposta su false per restituire un errore in caso di errore del criterio. Questo è un comportamento previsto per
la maggior parte dei criteri. Imposta su true per continuare l'esecuzione del flusso anche dopo un errore nel criterio. Vedi anche:
|
enabled |
true | Facoltativo | Imposta su true per applicare il criterio. Imposta su false per disattivare il
criterio. Il criterio non verrà applicato anche se rimane collegato a un flusso. |
async |
falso | Deprecato | Questo attributo è stato ritirato. |
Riferimento elemento secondario
In questa sezione vengono descritti gli elementi secondari di<SetIntegrationRequest>
.
<DisplayName>
Utilizzalo in aggiunta all'attributo name
per etichettare il criterio nell'editor proxy dell'interfaccia utente di gestione con un nome diverso e più naturale.
L'elemento <DisplayName>
è comune a tutti i criteri.
Valore predefinito | N/A |
Obbligatorio? | Facoltativo. Se ometti <DisplayName> , viene utilizzato il valore dell'attributo name del criterio. |
Tipo | Stringa |
Elemento principale | <PolicyElement> |
Elementi secondari | Nessuna esperienza |
La sintassi dell'elemento <DisplayName>
è la seguente:
Sintassi
<PolicyElement> <DisplayName>POLICY_DISPLAY_NAME</DisplayName> ... </PolicyElement>
Esempio
<PolicyElement> <DisplayName>My Validation Policy</DisplayName> </PolicyElement>
L'elemento <DisplayName>
non ha attributi o elementi secondari.
<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/A |
Obbligatorio? | Facoltativo |
Tipo | String |
Elemento principale |
<SetIntegrationRequest> |
Elementi secondari | Nessuna |
L'elemento <ProjectId>
utilizza la seguente sintassi:
Sintassi
<ProjectId ref="FLOW_VARIABLE_NAME">GOOGLE_CLOUD_PROJECT_ID</ProjectId>
Esempio
L'esempio seguente configura il criterio in modo che utilizzi la variabile di flusso my_projectid_var
per recuperare l'ID progetto e, se la variabile di flusso non si risolve 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 | String | 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:
|
<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/A |
Obbligatorio? | Facoltativo |
Tipo | String |
Elemento principale |
<SetIntegrationRequest> |
Elementi secondari | Nessuna |
L'elemento <IntegrationName>
utilizza la seguente sintassi:
Sintassi
<IntegrationName ref="FLOW_VARIABLE_NAME">INTEGRATION_NAME</IntegrationName>
Esempio
L'esempio seguente configura il criterio in modo che utilizzi la variabile di flusso my_integration_ref
per recuperare il nome dell'integrazione e, se la variabile di flusso non si risolve in fase di runtime, utilizza 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 | String | Specifica la variabile di flusso da cui Apigee deve leggere il nome dell'integrazione. Puoi impostare
l'elemento <IntegrationName> in uno dei seguenti modi:
|
<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 Apigee Integration. Per informazioni sulle regioni supportate dell'Apigee Integration, consulta Regioni supportate.
Valore predefinito | N/A |
Obbligatorio? | Obbligatorio |
Tipo | String |
Elemento principale |
<SetIntegrationRequest> |
Elementi secondari | Nessuna |
L'elemento <IntegrationRegion>
utilizza la seguente sintassi:
Sintassi
<IntegrationRegion ref="FLOW_VARIABLE_NAME">INTEGRATION_REGION</IntegrationRegion>
Esempio
L'esempio seguente configura il criterio 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 si risolve in fase di runtime, asia-east1
viene utilizzato 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 | String | Specifica la variabile di flusso da cui Apigee deve leggere la regione di integrazione. Puoi impostare
l'elemento <IntegrationRegion> in uno dei seguenti modi:
|
<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 con il trigger API specificato.
Valore predefinito | N/A |
Obbligatorio? | Obbligatorio |
Tipo | String |
Elemento principale |
<SetIntegrationRequest> |
Elementi secondari | Nessuna |
L'elemento <ApiTrigger>
utilizza la seguente sintassi:
Sintassi
<ApiTrigger ref="FLOW_VARIABLE_NAME">API_TRIGGER_NAME</ApiTrigger>
Esempio
L'esempio seguente configura il criterio in modo che utilizzi la variabile di flusso my_api_trigger_ref
per recuperare il nome del trigger API e, se la variabile di flusso non si risolve in fase di runtime, utilizza 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 | String | 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:
|
<ScheduleTime>
Specifica l'ora 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'esecuzione dell'integrazione è pianificata
per il 15/01/2022 alle ore 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'esecuzione dell'integrazione è pianificata
per il 15/01/2022 alle 01:30:15 PST. Per saperne di più sul formato dell'ora, consulta
Rappresentazioni combinate di data e ora.
Valore predefinito | N/A |
Obbligatorio? | Facoltativo |
Tipo | String |
Elemento principale |
<SetIntegrationRequest> |
Elementi secondari | Nessuna |
L'elemento <ScheduleTime>
utilizza la seguente sintassi:
Sintassi
<ScheduleTime>PARAMETER_VALUE</ScheduleTime>
Esempio
L'esempio seguente 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/A |
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 | Carbone | Consente di impostare delimitatori personalizzati per passare i valori delle variabili di flusso come argomenti del modello nell'elemento secondario <Parameter> .
|
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, dichiarazioni come <Parameter></Parameter>
e
<ParameterArray></ParameterArray>
vengono trattate come
valori null
.
<Parameter>
Specifica un parametro di input.
Valore predefinito | N/A |
Obbligatorio? | Facoltativo |
Tipo | String |
Elemento principale |
<Parameters> |
Elementi secondari | Nessuna |
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 suo 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 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 Parameter. Apigee risolve la variabile di flusso flowval in fase di runtime e utilizza il suo 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 la variabile di flusso flowval in fase di runtime e utilizza il suo valore. Viene segnalata un'eccezione se il valore flowval risolto non è valido.
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 doppio 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 per numeri interi 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
si risolve correttamente, my_int_param_1
è impostato sul valore della
variabile di flusso. Tuttavia, se flow_var_1
non riesce a risolvere,
my_int_param_1
è impostato su 96
.
Esempio 4
L'esempio seguente 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
si risolve correttamente, my_json_param_1
è impostato sul valore della
variabile di flusso flow_var_1
. Tuttavia, se flow_var_1
non si risolve,
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
Nell'esempio seguente viene impostato il valore del parametro JSON template_json_param
utilizzando il valore della variabile di flusso trasmesso 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
si risolve correttamente, template_json_param
è impostato sul valore della
variabile di flusso flow_var_1
. Tuttavia, se flow_var_1
non viene risolto, Apigee genera un'eccezione.
Esempio 6
Nell'esempio seguente viene impostato 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
si risolve correttamente, template_json_param
è 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 <Parameter>
:
Attributo | Obbligatorio? | Tipo | Descrizione |
---|---|---|---|
name |
Obbligatorio | String | Nome del parametro. |
type |
Obbligatorio | String | Tipo di dati del parametro. I tipi supportati sono
integer , string , boolean ,
double e json . |
ref |
Facoltativo | String | Specifica la variabile di flusso da cui Apigee deve leggere il valore parametro. Apigee utilizza
i seguenti criteri per impostare il valore parametro:
|
<ParameterArray>
Specifica un array di parametri di input.
Valore predefinito | N/A |
Obbligatorio? | Facoltativo |
Tipo | Tipo complesso |
Elemento principale |
<Parameters> |
Elementi secondari |
<Value> |
L'elemento <Parameters>
può avere più
elementi <ParameterArray>
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>
.
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 un 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 doppio 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
è impostato sui valori dell'array flow_var_1
. Tuttavia, se flow_var_1
non riesce a risolvere, 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
è impostato sui valori dell'array flow_var_1
. Tuttavia, se flow_var_1
non riesce a risolvere, 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
è impostato sui valori dell'array flow_var_1
. Solo se
flow_var_1
non riesce a risolvere, 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 | String | Nome dell'array di parametri. |
type |
Obbligatorio | String | Tipo di dati dell'array di parametri. I tipi supportati sono
integer , string , boolean
e double . |
ref |
Facoltativo | String | Specifica la variabile di flusso da cui Apigee deve leggere i valori dell'array. Apigee utilizza
i seguenti criteri per impostare il valore parametro:
|
<Value>
Specifica il valore di un elemento array.
Valore predefinito | N/A |
Obbligatorio? | Facoltativo |
Tipo | String |
Elemento principale |
<ParameterArray> |
Elementi secondari | Nessuna |
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"/>: risolvi la variabile di flusso refval in fase di runtime e utilizza il suo 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 suo valore. Apigee segnala un'eccezione se il valore refval risolto non è valido. Se refval non si risolve, Apigee utilizza val come valore dell'elemento.
- <Value>val1 $#flowval#$</Value>: utilizza
$#FLOW_VARIABLE_NAME#$
per passare i valori della variabile di flusso come argomento del modello in Valore. Apigee risolve la variabile di flusso flowval in fase di runtime e utilizza il suo valore. Viene segnalata un'eccezione se il valore flowval risolto non è valido.
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 un array di parametri con numeri interi
con 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 di 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 di 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 si risolve correttamente, il valore dell'elemento array è impostato sul valore della variabile di flusso flow_var_1
. Tuttavia, se flow_var_1
non riesce a risolvere,
il valore dell'elemento array è impostato su string_1
.
Esempio 4
L'esempio seguente imposta il valore del parametro array di stringa template_strArray_param
utilizzando il valore della variabile di flusso trasmesso 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 si risolve correttamente, il valore dell'elemento array è impostato sul valore della variabile di flusso flow_var_1
. Tuttavia, se flow_var_1
non riesce a risolvere, Apigee genera un'eccezione.
La tabella seguente descrive gli attributi di <Value>
:
Attributo | Obbligatorio? | Tipo | Descrizione |
---|---|---|---|
ref |
Facoltativo | String | Specifica la variabile di flusso da cui Apigee deve leggere il valore parametro. Apigee utilizza
i seguenti criteri per impostare il valore parametro:
|
<Request>
Specifica il nome della variabile di flusso per salvare la richiesta.
Una volta eseguito il criterio, viene creato un nuovo oggetto request message e l'oggetto viene salvato nella variabile FLOW_VARIABLE_NAME
su cui puoi eseguire una query per leggerla.
Se non specifichi un nome per la variabile di flusso, il criterio salva la richiesta nel messaggio di richiesta, sostituendo il messaggio di richiesta esistente, se presente.
Valore predefinito | request |
Obbligatorio? | Facoltativo |
Tipo | String |
Elemento principale |
<SetIntegrationRequest> |
Elementi secondari | Nessuna |
L'elemento <Request>
utilizza la seguente sintassi:
Sintassi
<Request>FLOW_VARIABLE_NAME</Request>
Esempio
Nell'esempio seguente l'oggetto della richiesta viene salvato nella variabile di flusso my_request_var
:
<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.
Codice di errore | Stato HTTP | Causa |
---|---|---|
steps.setintegrationrequest.EmptyParameterArray |
500 |
Questo errore si verifica quando l'elemento |
steps.setintegrationrequest.EmptyParameterArrayValue |
500 |
Questo errore si verifica quando l'elemento |
steps.setintegrationrequest.InvalidResolvedFlowVariable |
500 |
Questo errore si verifica quando la variabile di flusso specificata
nell'attributo
|
steps.setintegrationrequest.MismatchedTypeAndResolvedRef |
500 |
Questo errore si verifica quando la variabile di flusso specificata nell'attributo |
steps.setintegrationrequest.MismatchedTypeAndResolvedRefOfParameterArray |
500 |
Questo errore si verifica quando la variabile di flusso specificata
nell'attributo |
steps.setintegrationrequest.MismatchedTypeAndResolvedRefOfParameterArrayValue |
500 |
Questo errore si verifica quando la variabile di flusso specificata nell'attributo |
steps.setintegrationrequest.RequestVariableNotMessageType |
500 |
Questo errore si verifica quando la variabile di flusso specificata dall'elemento Request non è di tipo message. |
steps.setintegrationrequest.RequestVariableNotRequestMessageType |
500 |
Questo errore si verifica quando la variabile di flusso specificata dall'elemento Request non è di tipo Messaggio di richiesta. |
steps.setintegrationrequest.UnresolvedVariable |
500 |
Questo errore si verifica quando Apigee non riesce a risolvere le variabili di flusso specificate negli
elementi |
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.
Variabili | Dove | Esempio |
---|---|---|
fault.name |
fault.name può corrispondere a qualsiasi errore elencato nella tabella Errori di runtime.
Il nome del guasto è l'ultima parte del codice di errore. |
fault.name Matches "UnresolvedVariable" |
SetIntegrationRequest.POLICY_NAME.failed |
POLICY_NAME è il nome specificato dall'utente del criterio che ha generato l'errore. | SetIntegrationRequest.set-integration-request-1.failed = true |
Argomenti correlati
Per saperne di più sulla funzionalità di integrazione di Apigee, consulta Che cos'è Apigee Integration?