set-variable

set-variable ポリシーを使用して、ランタイム変数の値を設定したり、ランタイム変数を追加またはクリアしたりします。

ゲートウェイのサポート

表 1. このポリシーをサポートするゲートウェイと、対応するポリシーのバージョンを示す表
ゲートウェイ	ポリシーのバージョン
DataPower® Gateway (v5 compatible)	1.0.0
DataPower API Gateway	2.0.0

このトピックでは、 OpenAPI ソースでのポリシーの構成方法について説明します。アセンブリー・ユーザー・インターフェースでのポリシーの構成方法について詳しくは、変数の設定を参照してください。

製品情報

set-variable ポリシーの形式は次のとおりです。

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

プロパティ－

表 2. set-variable ポリシーのプロパティー
プロパティー	必須	説明	データ・タイプ
version	はい	ポリシーのバージョン番号	ストリング
title	いいえ	ポリシーのタイトル。	ストリング
description	いいえ	ポリシーの説明。	ストリング
actions	はい	set-variable ポリシーによって実行されるアクションをリストします。	アレイ
set	はい¹	変数の設定用。設定する変数の名前を指定します。 ¹プロパティー set、add、または clear のいずれかが必須です。	ストリング
add	はい²	変数の追加用。追加する変数の名前を指定します。 ²プロパティー set、add、または clear のいずれかが必須です。	ストリング
clear	はい³	変数のクリア用。クリアする変数の名前を指定します。 ³プロパティー set、add、または clear のいずれかが必須です。	ストリング
value	はい⁴	この値を指定した変数に割り振ります。リテラル値か、別の変数を指定できます。 ⁴value が必要となるのは、`set` または `add` がアクションとして指定されている場合のみです。	ストリング
type	はい	変数のデータ・タイプを指定します。有効値: `any` `string` `number` `boolean` `any` 以外の値を指定した場合は、その指定したデータ型に照らして値が検証されます。 nデータ型を `boolean` と指定した場合は、value プロパティーを `true` または `false` に設定する必要があります。	ストリング

例 1

# clear a variable

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

例 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

例 3

# add a variable

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