組み込みポリシー
IBM® API Connect は、多くの組み込みポリシーを備えています。組み込みポリシーは、事前構成されたポリシー・ステートメントを操作に適用するために使用され、API の呼び出し時にゲートウェイ・サーバー内の処理の特定の側面を制御することができます。
注: 組み込みポリシーには、DataPower® Gateway と Micro Gateway の両方で使用できるものと、特定のゲートウェイに制限されているものがあります。以下のアイコンは、どちらのゲートウェイで各ポリシーが使用できるかを示します。
- ポリシーが DataPower Gateway で実行可能であることを示します。
- ポリシーが Micro Gateway で実行可能であることを示します。
重要: IBM API Connect for IBM Cloud™ を使用する場合は、DataPower Gateway で実行可能なポリシーのみを適用する必要があります。
組み込みポリシーは、API のコンテキスト内で構成されます。API Designer アセンブリー・エディターを使用して、組み込みポリシーを API に追加し、そのポリシーのプロパティーを構成することができます。
OpenAPI (Swagger 2.0) 定義ファイルを作成することで、組み込みポリシーを API に追加することもできます。詳しくは、OpenAPI (Swagger 2.0) 定義ファイルの作成を参照してください。
以下の表に、使用可能な組み込みポリシーのリストと、各ポリシーが特定のゲートウェイに制限されているのか、両方のゲートウェイで使用可能かを示します。この表には、組み込みポリシーの定義および OpenAPI (Swagger 2.0) ポリシーの定義の両方についての構成情報へのリンクがあります。これらのポリシーは同じですが、作成方法が異なります。
組み込みポリシー | OpenAPI (Swagger 2.0) ポリシー | 説明 | ||
---|---|---|---|---|
Activity Log1 | activity-log | Activity Log ポリシーを使用して、分析に保管されている API アクティビティー用にロギングの設定を構成します。ユーザーが指定する設定は、API アクティビティーの詳細の収集および保管に関するデフォルトの設定値をオーバーライドします。 | ||
GatewayScript | gatewayscript | gatewayscript ポリシーは、特定の DataPower GatewayScript プログラムを実行するために使用します。 | ||
Generate LTPA Token | ltpa-generate | IBM API Connect の Generate LTPA Token セキュリティー・ポリシーは、LTPA (Lightweight Third Party Authentication) トークンを生成するために使用します。 | ||
Invoke | invoke | Invoke ポリシーを適用して、アセンブリー内から別のサービスを呼び出します。バックエンドからの応答は変数 message.body または応答オブジェクト変数 (定義されている場合) のいずれかに保存されます。このポリシーは、JSON データまたは XML データに使用でき、アセンブリー内で複数回適用できます。 | ||
JavaScript | javascript | JavaScript ポリシーは、特定の JavaScript プログラムを実行するために使用します。 | ||
JSON to XML | json-to-xml | JSON to XML ポリシーは、API のコンテキスト・ペイロードを JavaScript Object Notation (JSON) 形式から Extensible Markup Language (XML) 形式に変換するために使用します。 | ||
Generate JWT | jwt-generate | IBM API Connect の Generate JWT セキュリティー・ポリシーは、JSON Web トークン (JWT) を生成するために使用します。 | ||
Validate JWT | jwt-validate | Validate JWT セキュリティー・ポリシーは、API へのアクセスを許可する前に、要求内の JSON Web トークン (JWT) の検証を可能にするために使用します。 | ||
Map | map | 変換をアセンブリー・フローに適用し、変数間の関係を指定するには、Map ポリシーを使用します。 | ||
Proxy | proxy | アセンブリー内で別の API を呼び出すには、Proxy ポリシーを適用します (特に、その別の API でサイズの大きなペイロードを使用する場合)。バックエンドからの応答は message.body および応答オブジェクト変数 (定義されている場合) に保存されます。1 つのアセンブリー・フローで実行できるポリシーは 1 つだけです。 | ||
Redaction | redact | Redaction ポリシーを使用して、要求の本文、応答の本文、およびアクティビティー・ログから、指定されたフィールドを完全に削除するか、それらのフィールドを編集します。法律、 セキュリティー、その他の理由により、機密データ (例えば、 クレジット・カードの詳細) を削除またはブロックするためにこのポリシーは役立ちます。 | ||
Set Variable | set-variable | Set Variable ポリシーを使用して、ランタイム変数をストリング値に設定したり、ランタイム変数をクリアしたり、ヘッダー変数を追加したりします。 | ||
Validate | validate | Validate ポリシーを使用して、アセンブリー・フロー内のペイロードを JSON または XML スキーマと突き合わせて検証します。 | ||
Validate ポリシーを使用して、アセンブリー・フロー内のペイロードを JSON または XML スキーマと突き合わせて検証します。 現在は、Micro Gateway で validate ポリシーを使用して、アセンブリー・フロー内のペイロードを JSON スキーマと突き合わせて検証することもできます。 |
||||
Validate Username Token | validate-usernametoken | Validate Username Token ポリシーは、保護リソースへのアクセスを許可する前に、SOAP ペイロード内の Web サービス・セキュリティー (WS-Security) UsernameToken を検証するために使用します。 | ||
XML to JSON | xml-to-json | XML to JSON ポリシーは、API のコンテキスト・ペイロードを Extensible Markup Language (XML) 形式から JavaScript Object Notation (JSON) 形式に変換するために使用します。 | ||
XSLT | xslt | XSLT ポリシーは、XSLT 変換を API 定義のペイロードに適用するために使用します。 |
1
注: Micro Gateway は Activity
Log ポリシーをサポートしません。ただし、Micro Gateway は基本的な分析統計を収集します。Micro Gateway が収集する統計は、以下の一部の例外を除いて、Content:activity が設定された DataPower Gateway の Activity
Log ポリシーが収集するものに相当します。
- requestHttpHeaders、responseHttpHeaders、および debug の各フィールドについては、Micro Gateway は情報を収集せずに空のペイロードを送信します。
- 有効な管理サーバーを指定する APIMANAGER 環境変数を使用して Micro Gateway を開始すると、Micro Gateway は基本分析統計を自動的に収集します。実行時に収集機能をオンまたはオフにするメカニズムはありません。