set-variable

Modifier en ligne

Utilisez la règle set-variable pour définir la valeur d'une variable d'exécution ou pour ajouter ou effacer une variable d'exécution.

Prise en charge des passerelles

Tableau 1. Tableau indiquant les passerelles prenant en charge cette politique, ainsi que la version correspondante de la politique
Passerelle	Version de la stratégie
DataPower® Gateway (v5 compatible)	1.0.0
DataPower API Gateway	2.0.0

Cette rubrique explique comment configurer la stratégie dans votre source « OpenAPI »; pour plus de détails sur la configuration de la stratégie dans l'interface utilisateur de l'assemblage, consultez la rubrique « Définir une variable ».

A propos de

Cette stratégie a le format suivant :

- set-variable:
  version: version
  title: title
  description: description
  actions:
    - action_type: variable_name
      value: value
      type: data_type

Propriétés

Tableau 2. Propriétés de la politique de définition des variables
Propriété	Obligatoire	Descriptif	Type de données
version	Oui	Numéro de version de la stratégie	chaîne
title	Non	Titre de la stratégie.	chaîne
description	Non	Description de la stratégie.	chaîne
actions	Oui	Répertorie les actions à effectuer par la règle set-variable .	tableau
set	Oui¹	Permet de définir une variable. Indiquez le nom de la variable que vous souhaitez définir. ¹L'une des propriétés set, add ou clear est requise.	chaîne
add	Oui²	Permet d'ajouter une variable. Indiquez le nom de la variable que vous souhaitez ajouter. ²L'une des propriétés set, add ou clear est requise.	chaîne
clear	Oui³	Permet d'effacer une variable. Indiquez le nom de la variable que vous souhaitez effacer. ³L'une des propriétés set, add ou clear est requise.	chaîne
value	Oui⁴	Alloue la valeur à la variable spécifiée. Il peut s'agit d'une valeur littérale ou d'une autre variable. ⁴Le paramètre value est requis uniquement lorsque `set` ou `add` est défini comme action.	chaîne
type	Oui	Indique le type de données de la variable. Valeurs valides : `any` `string` `number` `boolean` Pour toutes les valeurs autres que `any`, la valeur est comparée au type de données spécifié. Si le type de données spécifié est `boolean`, la propriété de la valeur doit être définie sur `true` ou `false`.	chaîne

Exemple 1

# clear a variable

set-variable:
  version: 1.0.0
  title: clear_region
  actions:
    - clear: message.headers.region

Exemple 2

# set a variable to the value of an API Gateway context variable

set-variable:
  version: 2.0.0
  title: set content type
  actions:
    - set: message.headers.contenttype
      value: $(message.headers.content-type)
      type: string

Exemple 2

# add a variable

assembly:
    execute:
      - set-variable:
          version: 2.0.0
          title: set-variable
          actions:
            - value: testing add
              add: message.headers.jja
              type: string