メインコンテンツまでスキップ

Policy Overview

APIポリシーの概要

APIMシステムのAPIポリシーは、認証、レート制限、キャッシング、変換などの重要な機能を提供し、セキュリティ、パフォーマンス、柔軟性を向上させます。管理者は、APIトラフィックが効率的に管理されるように、APIレベルでこれらのポリシーを構成できます。

ポリシーは以下のように分かれています:

  • Inbound: バックエンドに到達する前にリクエストを修正します(例:ヘッダーの変換、IP制限)。
  • Outbound: クライアントに到達する前にレスポンスを修正します(例:ログ記録、ヘッダーの追加)。

APIMコンソールでは、ユーザーは各APIのためにapply, configure, and manage policiesを行うことができます。このガイドでは、各ポリシーの構成方法を知ることができます。カバーされるポリシーは以下の通りです:

InboundOutbound
キー認証 (Key Auth)プロキシキャッシュ
レート制限レスポンストランスフォーマー
トランザクションID (Txid)クロスオリジンリソースシェアリング (CORS)
OpenID Connect (OIDC)
リクエストトランスフォーマー
プリーファンクション
リクエストトランスフォーマー (高度)
サーキットブレーカー
SAML

APIポリシー詳細画面へのアクセス

ユーザーは、以下の方法でAPIポリシー詳細画面にアクセスできます:

  • When setting up for a project’s API Basic Policy. Please refer to User Guide/APIM Console Guide/API Basic Policy Settings/How to set up API Basic Policy
  • When configuring an API, please refer to User Guide/APIM Console Guide/API Management/API Policies Applying.

APIポリシーの構成

APIポリシー詳細画面では、ユーザーは適用セクションにリストされたポリシーをクリックすることでAPIポリシーを構成できます。ポリシーの詳細は、その下の新しいセクションに表示されます。 APIポリシーの設定

ポリシー詳細ガイド構造

各APIポリシーの設定方法については、APIポリシー詳細の該当ガイドを参照してください。各ポリシーは以下の共通構造で説明されます。

概要

  • ポリシーが何をするのか、その主な目的を簡潔に説明します。
  • このポリシーが適用される一般的なユースケースを挙げます。
  • ポリシーの主な機能をリストします。
  • 必要に応じて、主要なコンポーネント(例:タグ、パラメータ、状態)を説明します。

設定の詳細

パラメータとフィールドの入力方法を説明します。

スクリーンショット

各詳細を示すために、スクリーンショットが添付されています。