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.
Valore predefinito | N/D |
Obbligatorio? | Obbligatorio |
Tipo | Tipo complesso |
Elemento principale | N/D |
Elementi secondari |
<ApiTrigger> <DisplayName> <IntegrationName> <IntegrationRegion> <Parameters> <ProjectId> <Request> <ScheduleTime> |
La seguente tabella 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 esiste l'integrazione. |
<Parameters> |
Facoltativo | Parametri di input dell'integrazione. |
<ProjectId> |
Facoltativo | Nome del progetto Google Cloud che include l'integrazione che vuoi eseguire. |
<Request> |
Facoltativo | Nome della variabile di flusso per salvare l'oggetto di richiesta. |
<ScheduleTime> |
Facoltativo | Il momento 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 Se vuoi, utilizza l'elemento |
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:
|
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 elemento secondario
In questa sezione vengono descritti 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
L'esempio seguente configura il criterio in modo da 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 esecuzione, utilizza apigee_staging_1
come ID progetto:
<ProjectId ref="my_projectid_var">apigee_staging_1</ProjectId>
Nella tabella seguente vengono descritti 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:
|
<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.
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 il criterio in modo da utilizzare 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 esecuzione, 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 | 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:
|
<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.
Valore predefinito | N/D |
Obbligatorio? | Obbligatorio |
Tipo | Stringa |
Elemento principale |
<SetIntegrationRequest> |
Elementi secondari | Nessuno |
La sintassi dell'elemento <IntegrationRegion>
è la seguente:
Sintassi
<IntegrationRegion ref="FLOW_VARIABLE_NAME">INTEGRATION_REGION</IntegrationRegion>
Esempio
L'esempio seguente configura il criterio in modo da utilizzare la variabile di flusso my_integration_region_ref
per recuperare la regione di integrazione e, se la risoluzione della variabile di flusso non riesce in fase di esecuzione, viene utilizzata asia-east1
come regione dell'integrazione:
<IntegrationRegion ref="my_integration_region_ref">asia-east1</IntegrationRegion>
Nella tabella seguente vengono descritti 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:
|
<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.
Valore predefinito | N/D |
Obbligatorio? | Obbligatorio |
Tipo | Stringa |
Elemento principale |
<SetIntegrationRequest> |
Elementi secondari | Nessuno |
La sintassi dell'elemento <ApiTrigger>
è la seguente:
Sintassi
<ApiTrigger ref="FLOW_VARIABLE_NAME">API_TRIGGER_NAME</ApiTrigger>
Esempio
Il seguente esempio configura il criterio in modo da utilizzare la variabile di flusso my_api_trigger_ref
per recuperare il nome dell'attivatore dell'API e, se la variabile di flusso non viene risolta in fase di esecuzione, utilizza api_trigger/API-Trigger-2
come nome dell'attivatore dell'API:
<ApiTrigger ref="my_api_trigger_ref">api_trigger/API-Trigger-2</ApiTrigger>
Nella tabella seguente vengono descritti 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:
|
<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.
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
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/D |
Obbligatorio? | Facoltativo |
Tipo | Tipo complesso |
Elemento principale |
<SetIntegrationRequest> |
Elementi secondari |
<Parameter> <ParameterArray> |
Nella tabella seguente vengono descritti gli attributi di <Parameters>
:
Attributo | Obbligatorio? | Tipo | Descrizione |
---|---|---|---|
substitutionVariableChar |
Facoltativo | Carattere | Ti consente di impostare delimitatori personalizzati per trasmettere i valori delle variabili di flusso come argomenti del modello nell'elemento secondario <Parameter> .
|
La sintassi dell'elemento <Parameters>
è la seguente:
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
Nell'esempio seguente vengono inizializzati il parametro my_str_param
e il parametro
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
. Per
ad esempio dichiarazioni come <Parameter></Parameter>
e
<ParameterArray></ParameterArray>
vengono trattate come
null
valori.
<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"/>: 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="string" 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:
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 a 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 al parametro il valore della variabile di flusso flow_var
.
<Parameters> <Parameter name="my_double_param" type="double" ref="flow_var"/> </Parameters>
Esempio 3
L'esempio seguente imposta il valore per il 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 flow_var_1
la variabile di flusso viene risolta, my_int_param_1
è impostato sul valore della
come una variabile di flusso. Tuttavia, se flow_var_1
non riesce a risolvere il problema,
my_int_param_1
impostato su 96
.
Esempio 4
L'esempio seguente imposta i valori per my_json_param_1
e
my_json_param_2
parametri JSON.
<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 flow_var_1
la variabile di flusso viene risolta, my_json_param_1
è impostato sul valore della
Variabile di flusso flow_var_1
. Tuttavia, se l'errore flow_var_1
non viene risolto,
my_json_param_1
impostato su {name:"Apple", color:"Red"}
. La
Il parametro my_json_param_2
è impostato su {name:"Banana", color:"Yellow"}
perché è presente
non è specificato alcun attributo ref
.
Esempio 5
L'esempio seguente imposta il valore per il 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 flow_var_1
la variabile di flusso viene risolta, template_json_param
è impostato sul valore della
Variabile di flusso flow_var_1
. Tuttavia, se l'errore flow_var_1
non viene risolto, Apigee genera un'eccezione.
Esempio 6
L'esempio seguente imposta il valore per il 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 l'errore flow_var_1
non viene risolto, Apigee genera un'eccezione.
Nella tabella seguente vengono descritti gli attributi di <Parameter>
:
Attributo | Obbligatorio? | Tipo | Descrizione |
---|---|---|---|
name |
Obbligatorio | Stringa | Nome del parametro. |
type |
Obbligatorio | Stringa | 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 del parametro. Apigee utilizza
seguenti criteri per impostare il valore parametro:
|
<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ò 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:
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 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 di doppi, dove:
- 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
Impossibile risolvere flow_var_1
, l'array my_array_param
è impostato
ai 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
si risolve correttamente, my_array_param
è impostato sui valori dell'array flow_var_1
. Tuttavia, se
Impossibile risolvere flow_var_1
, Apigee segnala un'eccezione.
Esempio 5
L'esempio seguente dichiara my_array_param
come array di stringhe e lo imposta
ai 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
si risolve 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>
.
Nella tabella seguente vengono descritti 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 del flusso da cui Apigee deve leggere i valori dell'array. Apigee utilizza
seguenti criteri per impostare il valore parametro:
|
<Value>
Specifica il valore di un elemento array.
Valore predefinito | N/D |
Obbligatorio? | Facoltativo |
Tipo | Stringa |
Elemento principale |
<ParameterArray> |
Elementi secondari | Nessuno |
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:
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 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 di stringa
con i 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 del flusso viene risolta correttamente, il valore dell'elemento dell'array viene impostato sul valore della variabile del flusso flow_var_1
. Tuttavia, se flow_var_1
non riesce a risolvere il problema,
il valore dell'elemento array è 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
non viene risolta correttamente, il valore dell'elemento array è impostato sul valore
Variabile di flusso flow_var_1
. Tuttavia, se flow_var_1
non riesce a risolvere il problema,
Apigee genera un'eccezione.
Nella tabella seguente vengono descritti gli attributi di <Value>
:
Attributo | Obbligatorio? | Tipo | Descrizione |
---|---|---|---|
ref |
Facoltativo | Stringa | Specifica la variabile di flusso da cui Apigee deve leggere il valore del parametro. Apigee utilizza
seguenti criteri per impostare il valore parametro:
|
<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.
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
Nell'esempio seguente, l'oggetto di 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 Informazioni importanti sugli errori relativi alle norme e Gestione degli errori.
Errori di runtime
Questi errori possono verificarsi durante l'esecuzione del criterio.
Codice guasto | 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. Spesso i messaggi di errore generati dal sistema potrebbero non essere pertinenti nel contesto del tuo prodotto. Ti consigliamo di personalizzare i messaggi di errore in base al tipo di errore per renderli più significativi.
Per personalizzare i messaggi di errore, puoi utilizzare le regole di errore o il criterio RaiseFault. Per informazioni sulle differenze tra le regole di errore e il criterio RaiseFault, consulta Regole di errore e criterio RaiseFault.
Devi verificare la presenza di condizioni utilizzando l'elemento Condition
sia nelle regole di errore sia nel criterio RaiseFault.
Apigee fornisce variabili di errore univoche per ogni criterio e i valori delle variabili di errore vengono impostati quando un criterio attiva errori di runtime.
Utilizzando queste variabili, puoi verificare la presenza di condizioni di errore specifiche e intraprendere le azioni appropriate. Per ulteriori informazioni su come controllare le condizioni di errore, consulta Condizioni di compilazione.
La tabella seguente descrive le variabili di errore specifiche per questo criterio.
Variabili | Dove | Esempio |
---|---|---|
fault.name |
fault.name può corrispondere a uno dei problemi elencati nella tabella Errori di runtime.
Il nome dell'errore è l'ultima parte del codice dell'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 scoprire di più sulla funzionalità di integrazione delle applicazioni, consulta Panoramica di Application Integration