実行

アセンブリーの execute フィールドの構造は以下のとおりです。

execute:
 - Policy_1
 - Policy_2
注: 一部の組み込みポリシーは DataPower® Gateway (v5 compatible)DataPower API Gatewayの両方で使用できますが、一部のポリシーは特定のゲートウェイに制限されています。 以下のアイコンは、どちらのゲートウェイで各ポリシーが使用できるかを示します。
  • DataPower ゲートウェイ・アイコンポリシーを DataPower Gateway (v5 compatible)で実行できることを示します。
  • DataPower ゲートウェイ・アイコンポリシーを DataPower API Gatewayで実行できることを示します。

2種類のゲートウェイの詳細については、API Connectゲートウェイの種類を参照してください。

以下の表で、execute フィールドに含めることができる、予想されるポリシーおよびロジック構成体について説明します。

表 1. プロパティーの実行
プロパティー 必須 説明 データ型 DataPower ゲートウェイ・アイコン DataPower ゲートウェイ・アイコン
activity-log いいえ activity-log ポリシーを使用して、API 操作の呼び出しに関連する情報をログに記録します。 オブジェクト (activity-log) はい はい

activity-log 拡張機能によって提供される機能

client-security いいえ API に対するクライアント・アクセスをさまざまな方法で認証できるようにして、OpenAPI 仕様の機能を拡張します。 オブジェクト (client-security) いいえ はい
gatewayscript いいえ GatewayScript プログラムを組み込みます。 オブジェクト (gatewayscript) はい はい
graphql-cost-analysis いいえ graphql-cost-analysisポリシーを使用して、ターゲットクエリのコスト分析を返します。 オブジェクト(graphql-cost-analysis) いいえ はい
graphql-execute いいえ graphql-executeポリシーを使用して、サブクエリを使用してGraphQLクエリを実行します。 オブジェクト(graphql-execute) いいえ はい
graphql-introspect いいえ graphql-introspect ポリシーを使用して、 GraphQL スキーマをイントロスペクトします。 オブジェクト(graphql-introspect) いいえ はい
if いいえ if ポリシーを使用して、条件が満たされている場合にのみアセンブリーの一部分を実行します。 たいしょう はい はい

スイッチが提供する機能

invoke いいえ invoke ポリシーを使用して API を呼び出します。

パフォーマンスを向上させるために、ポリシー内の最後の呼び出しがプロキシーによって自動的に置き換えられる場合があります。 これを無効にするにはAPIプロパティ

オブジェクト (呼ぶ) はい はい
json-to-xml いいえ ペイロードを JSON から XML に変換します。 オブジェクト(json-to-xml) はい はい
jwt-generate いいえ JSON Web トークン (JWT) を生成します。 オブジェクト(jwt-generate) はい はい
jwt-validate いいえ JSON Web トークン (JWT) を検証します。 オブジェクト(jwt-validate) はい はい
log いいえ log ポリシーを使用して、API のデフォルトのアクティビティー・ロギング構成をカスタマイズまたはオーバーライドします。 対象 いいえ はい
map いいえ map ポリシーを使用して変数を変換します。 オブジェクト (地図) はい はい
operation-switch いいえ 呼び出される操作を条件とする代替ポリシー・アセンブリーを実行する際は、operation-switch ポリシーを使用します。 オブジェクト (操作スイッチ) はい はい
oauth いいえ oauth ポリシーを使用して、定義された OAuth プロバイダー設定に基づいて OAuth 処理を実行します。 オブジェクト (認証) いいえ はい
parse いいえ parse ポリシーを使用して、入力文書の構文解析を制御します。 入力文書が JSON ストリングである場合、そのストリングは上書きコピーされるのではなく構文解析されます。 オブジェクト (パース) いいえ はい
proxy いいえ サービスをプロキシー化します。 オブジェクト(プロキシ) はい はい

invokeが提供する機能

ratelimit いいえ API アセンブリー・フローの任意の時点で 1 つ以上のレート制限またはバースト制限を適用するには、 ratelimit ポリシーを使用します。 レート制限およびバースト制限は、指定した期間内にアプリケーションが API に対して実行できる呼び出しの数を制限します。 オブジェクト(ratelimit) いいえ はい
redact いいえ redact ポリシーを使用して、要求の本文、応答の本文、およびアクティビティー・ログから、指定されたフィールドを完全に削除するか、それらのフィールドを編集します。 法律、 セキュリティー、その他の理由により、機密データ (例えば、 クレジット・カードの詳細) を削除またはブロックするためにこのポリシーは役立ちます。 オブジェクト(redact -DataPower API Gateway-DataPower Gateway(v5互換)) はい はい
set-variable いいえ set-variable ポリシーを使用して、ランタイム変数をストリング値に設定したり、ランタイム変数の追加やクリアを行ったりします。 オブジェクト(セット変数) はい はい
switch いいえ switch ポリシーを使用して、指定したどの条件が満たされているかに基づいて、アセンブリーの多数のセクションのうちの 1 つを実行します。 オブジェクト(スイッチ) はい はい
throw いいえ throw ポリシーを使用して、エラーをスローするポイントを指定します。 オブジェクト(スロー) はい はい
user-defined-policy いいえ 独自のユーザー定義ポリシーを API に適用することができます。 オブジェクトユーザー定義ポリシー) はい はい
user-security いいえ ユーザーの資格情報を抽出し、それらの資格情報を認証して、ユーザーから許可を取得します。 オブジェクト (ユーザーセキュリティ) いいえ はい
validate いいえ 「検証」 ポリシーを使用して、アセンブリー・フロー内のペイロードを JSON または XML スキーマに照らして検証します。 オブジェクト(validate -DataPower API Gatewayvalidate -DataPower Gateway(v5互換)) はい はい
validate-usernametoken いいえ WS-Security UsernameToken を検証します。 オブジェクト(validate-usernametoken) はい いいえ
xml-to-json いいえ ペイロードを XML から JSON に変換します。 オブジェクト(xml-to-json) はい はい
xslt いいえ XSLT 変換をペイロードに適用します。 オブジェクト(xslt) はい はい

以下の例に示すアセンブリーの execute フィールドは、URL を呼び出して、要求または応答のフィールドを編集します。

execute:
 - invoke:
  title: Example Invoke
  target-url: 'https://example.com/api'
  description: Example description
 - redact:
  actions:
   - action: redact
     from: 
      - request
      - response
    path: //*[@name='secondaryAddress']/*[@name='streetAddress']