Règle SetIntegrationRequest

Cette page s'applique à Apigee et à Apigee hybrid.

Consultez la documentation d'Apigee Edge.

Présentation

La règle SetIntegrationRequest vous permet de créer un objet de requête pour une intégration que vous souhaitez exécuter. Dans la règle, vous devez configurer les détails du déclencheur d'API et les paramètres d'entrée requis pour exécuter l'intégration. Lorsque vous exécutez la règle SetIntegrationRequest, elle crée un objet de requête et l'enregistre dans une variable de flux. L'objet de la requête contient toutes les informations requises pour exécuter l'intégration. À ce stade, l'intégration n'est toujours pas exécutée. Pour exécuter l'intégration, vous devez appeler la règle IntegrationCallout ou définir un IntegrationEndpoint. La règle IntegrationCallout et IntegrationEndpoint requièrent tous deux l'objet de la requête pour exécuter l'intégration.

Cette règle est une règle extensible et son utilisation peut avoir des conséquences sur le coût ou l'utilisation, en fonction de votre licence Apigee. Pour en savoir plus sur les types de règles et les implications en termes d'utilisation, consultez la section Types de règles.

<SetIntegrationRequest>

Spécifie la règle SetIntegrationRequest.

Le tableau suivant fournit une description détaillée des éléments enfants de l'élément <SetIntegrationRequest> :

La règle SetIntegrationRequest utilise la syntaxe suivante :

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

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

Cet élément possède les attributs suivants qui sont communs à toutes les règles :

Référence d'élément enfant

<DisplayName>

Utilisez-le, en plus de l'attribut name, pour appliquer un libellé à la règle dans l'éditeur de proxys de l'interface de gestion en utilisant un nom différent et plus naturel.

L'élément <DisplayName> est commun à toutes les règles.

L'élément <DisplayName> utilise la syntaxe suivante :

<PolicyElement>
  <DisplayName>POLICY_DISPLAY_NAME</DisplayName>
  ...
</PolicyElement>

<PolicyElement>
  <DisplayName>My Validation Policy</DisplayName>
</PolicyElement>

L'élément <DisplayName> ne comporte aucun attribut ni élément enfant.

<ProjectId>

Spécifie le nom du projet Google Cloud.

Apigee attribue la valeur que vous spécifiez pour cet élément à la variable de flux integration.project.id.

L'élément <ProjectId> utilise la syntaxe suivante :

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

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

Le tableau suivant décrit les attributs de <ProjectId> :

<IntegrationName>

Spécifie l'intégration à exécuter.

Apigee attribue la valeur que vous spécifiez pour cet élément à la variable de flux integration.name.

Le nom de l'intégration doit suivre les règles de dénomination suivantes :

• Doit commencer et se terminer par une lettre ou un chiffre.
• Ne peut pas comporter d'espaces.
• Deux tirets ou traits de soulignement ne peuvent pas être consécutifs.

L'élément <IntegrationName> utilise la syntaxe suivante :

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

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

Le tableau suivant décrit les attributs de <IntegrationName> :

<IntegrationRegion>

Spécifie la région où l'intégration existe.

Lors de l'exécution, Apigee attribue la valeur de l'élément à la variable de flux integration.region, crée une URL cible basée sur la région et stocke l'URL dans la variable de flux integration.target.url.

L'URL cible basée sur la région est au format suivant : https://integration.region-integrations.googleapis.com

La région d'intégration doit être compatible avec l'intégration Apigee. Pour en savoir plus sur les régions compatibles avec l'intégration Apigee, consultez la section Régions où le service est disponible.

L'élément <IntegrationRegion> utilise la syntaxe suivante :

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

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

Le tableau suivant décrit les attributs de <IntegrationRegion> :

<ApiTrigger>

Spécifie le déclencheur d'API à exécuter.

Vous devez spécifier le nom du déclencheur API au format api_trigger/API_TRIGGER_NAME.

Apigee attribue la valeur que vous spécifiez pour cet élément à la variable de flux integration.api.trigger.

Si vous avez spécifié <IntegrationName>, seul le déclencheur d'API de cette intégration est exécuté. Toutefois, si vous n'avez pas spécifié <IntegrationName>, toutes les intégrations portant le déclencheur d'API spécifié sont exécutées.

L'élément <ApiTrigger> utilise la syntaxe suivante :

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

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

Le tableau suivant décrit les attributs de <ApiTrigger> :

<ScheduleTime>

Indique l'heure à laquelle l'intégration doit s'exécuter.

Si la heure est inférieure ou égale à l'heure actuelle, l'intégration s'exécute immédiatement. Vous devez spécifier l'heure au format yyyy-mm-ddThh:mm:ssZ, où Z est le fuseau horaire UTC. Par exemple, si vous spécifiez 2022-01-15T01:30:15Z, l'intégration est planifiée pour s'exécuter le 15-1-2022 à 1:30:15 UTC. Vous pouvez également spécifier le fuseau horaire à l'aide d'un décalage par rapport à l'heure UTC. Par exemple, si vous spécifiez 2022-01-15T01:30:15-08:00, l'intégration est planifiée pour s'exécuter le 15-1-2022 à 1:30:15 PST. Pour en savoir plus sur le format de l'heure, consultez la section Représentations de la date et de l'heure combinées.

L'élément <ScheduleTime> utilise la syntaxe suivante :

<ScheduleTime>PARAMETER_VALUE</ScheduleTime>

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

<Parameters>

Spécifie les paramètres d'entrée requis pour exécuter l'intégration.

Vous pouvez spécifier des paramètres individuels ou des tableaux de paramètres.

• Pour spécifier un paramètre individuel, utilisez l'élément <Parameter>.
• Pour spécifier un tableau de paramètres, utilisez l'élément <ParameterArray>.

Le tableau suivant décrit les attributs de <Parameters> :

L'élément <Parameters> utilise la syntaxe suivante :

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

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

Apigee traite les éléments vides <Parameter> et <ParameterArray> comme des valeurs null. Par exemple, les déclarations telles que <Parameter></Parameter> et <ParameterArray></ParameterArray> sont traitées comme des valeurs null.

<Parameter>

Spécifie un paramètre d'entrée.

Vous pouvez spécifier la valeur du paramètre comme suit :

• <Parameter name="my_param" type="string">val</Parameter> : Utilise val comme valeur de paramètre. Si val n'est pas valide, Apigee signale une exception.
• <Parameter name="my_param" type="string" ref="refval"/> : résout la variable de flux refval au moment de l'exécution et utilise sa valeur. Apigee signale une exception si la valeur refval résolue n'est pas valide ou si la valeur refval est non résolue.
• <Parameter name="my_param" type="string" ref="refval">val</Parameter>: résout la variable de flux refval au moment de l'exécution et utilise sa valeur. Apigee signale une exception si la valeur refval résolue n'est pas valide. Si refval n'est pas résolu, Apigee utilise val comme valeur de paramètre.
• <Parameter name="my_param" type="json">{"name":"$#flowval#$"}</Parameter> : utilise $#FLOW_VARIABLE_NAME#$ pour transmettre à l'objet Parameter des valeurs de variable de flux sous forme d'argument de modèle. Apigee résout la variable de flux flowval au moment de l'exécution et utilise sa valeur. Une exception est signalée si la valeur flowval résolue n'est pas valide.
• <Parameter name="my_param" type="json">{"name":"SUBSTITUTION_CHAR flowval SUBSTITUTION_CHAR"}</Parameter> : où SUBSTITUTION_CHAR désigne la valeur spécifiée pour l'attribut substitutionVariableChar de l'élément parent <Parameters>. Apigee résout la variable de flux flowval au moment de l'exécution et utilise sa valeur. Une exception est signalée si la valeur flowval résolue n'est pas valide.

L'élément <Parameter> utilise la syntaxe suivante :

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

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

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

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

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

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

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

Le tableau suivant décrit les attributs de <Parameter> :

<ParameterArray>

Spécifie un tableau de paramètres d'entrée.

L'élément <Parameters> peut contenir plusieurs éléments <ParameterArray>. Pour un tableau de paramètres, vous pouvez définir la valeur des éléments du tableau en spécifiant la valeur réelle ou en spécifiant une variable de flux dans l'attribut ref. Si vous spécifiez une variable de flux, les éléments du tableau sont définis sur la valeur de la variable de flux. Les exemples de cette section décrivent les différentes manières de configurer l'élément <ParameterArray>.

L'élément <ParameterArray> utilise la syntaxe suivante :

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

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

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

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

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

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

Le tableau suivant décrit les attributs de <ParameterArray> :

<Value>

Spécifie la valeur d'un élément de tableau.

Chaque élément du tableau doit être un élément <Value> distinct. Vous pouvez spécifier la valeur comme suit :

• <Value>val</Value> : utilise val comme valeur de l'élément. Si val n'est pas valide, Apigee signale une exception.
• <Value ref="refval"/> : résout la variable de flux refval au moment de l'exécution et utilise sa valeur. Apigee signale une exception si la valeur refval résolue n'est pas valide ou si la valeur refval est non résolue.
• <Value ref="refval">val</Value> : résout la variable de flux refval au moment de l'exécution et utilise sa valeur. Apigee signale une exception si la valeur refval résolue n'est pas valide. Si refval n'est pas résolu, Apigee utilise val comme valeur de l'élément.
• <Value>val1 $#flowval#$</Value> : utilise $#FLOW_VARIABLE_NAME#$ pour transmettre à l'objet Value les valeurs des variables de flux sous forme d'argument de modèle. Apigee résout la variable de flux flowval au moment de l'exécution et utilise sa valeur. Une exception est signalée si la valeur flowval résolue n'est pas valide.

L'élément <Value> utilise la syntaxe suivante :

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

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

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

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

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

Le tableau suivant décrit les attributs de <Value> :

<Request>

Spécifie le nom de la variable de flux pour enregistrer la requête.

Une fois la règle exécutée, elle crée un objet de message de requête et l'enregistre dans la variable FLOW_VARIABLE_NAME que vous pouvez interroger pour lire la requête.

Si vous ne spécifiez pas de nom de variable de flux, la règle enregistre la requête dans le message de requête, en remplaçant le message de requête existant, le cas échéant.

L'élément <Request> utilise la syntaxe suivante :

<Request>FLOW_VARIABLE_NAME</Request>

<Request>my_request_var</Request>

Codes d'erreur

Cette section décrit les codes d'erreur, les messages d'erreur et les variables d'erreur définies par Apigee lorsque cette règle déclenche une erreur. Ces informations sont essentielles si vous développez des règles de défaillance afin de gérer les pannes. Pour en savoir plus, consultez les pages Ce que vous devez savoir à propos des erreurs liées aux règles et Gérer les pannes.

Erreurs d'exécution

Ces erreurs peuvent se produire lors de l'exécution de la règle.

Variables de panne

Chaque fois qu'une règle comporte des erreurs d'exécution, Apigee génère des messages d'erreur. Vous pouvez afficher ces messages d'erreur dans la réponse d'erreur. Souvent, les messages d'erreur générés par le système peuvent ne pas être pertinents dans le contexte de votre produit. Vous pouvez personnaliser les messages d'erreur en fonction du type d'erreur pour rendre les messages plus significatifs.

Pour personnaliser les messages d'erreur, vous pouvez utiliser des règles d'erreur ou la règle RaiseFault. Pour en savoir plus sur les différences entre les règles d'erreur et la règle RaiseFault, consultez la section Règles d'erreur et règle RaiseFault. Vous devez vérifier les conditions à l'aide de l'élément Condition dans les règles d'erreur et dans la règle RaiseFault. Apigee fournit des variables d'erreur propres à chaque règle et les valeurs des variables d'erreur sont définies lorsqu'une règle déclenche des erreurs d'exécution. En utilisant ces variables, vous pouvez vérifier des conditions d'erreur spécifiques et prendre les mesures appropriées. Pour en savoir plus sur la vérification des conditions d'erreur, consultez la page Conditions de création.

Le tableau suivant décrit les variables d'erreur spécifiques à cette règle.

Articles associés

Pour en savoir plus sur la fonctionnalité Application Integration, consultez la présentation d'Application Integration.