API Basic Policy Settings
API基本ポリシーの紹介
API Basic Policy は、プロジェクト内の新しいAPIに自動的に適用される、あらかじめ定義されたルールと設定のセットです。
デフォルトポリシーが変更される前にすでに作成されたAPIには、新しいデフォルトポリシーは適用されません。これは、すでに使用中のAPIのポリシーを変更すると、その機能が正常に動作しなくなる可能性があるためです。
これらのポリシーは、各APIに対して手動で設定を行うことなく、一貫したセキュリティ対策、リクエスト処理、およびデータ変換を強制するのに役立ちます。
API基本ポリシーの重要性
- Ensures Consistency: 標準化されたポリシーは、プロジェクト内のすべてのサービスで均一なAPIの動作を維持するのに役立ちます。
- Improves Security: 認証、レート制限、リクエスト検証などのデフォルトのセキュリティ対策は、脆弱性を減少させます。
- Simplifies API Management: ベストプラクティスの適用を自動化し、手動設定の必要性を減少させます。
- Enhances Performance: あらかじめ定義された変換ルールは、リクエストとレスポンスの処理を最適化します。
API基本ポリシー画面の機能
API Basic Policy 画面では、ユーザーは次のことができます：
- APIに利用可能なポリシーを表示する。
- 選択したプロジェクトに対してポリシーを適用または削除する。
- 実行順序、ヘッダー、リクエスト変換などのポリシーの詳細を設定する。
- 新しいAPIのデプロイメント全体でポリシーが強制されるように、APIポリシーを保存および管理する。
API基本ポリシーの設定方法
プロジェクト内で新しいAPIが作成されると、そのプロジェクトに設定されたAPI基本ポリシーを自動的に継承します。プロジェクトの基本ポリシーを設定するには、ユーザーは以下の手順に従うことができます：
ステップ 1: API 基本ポリシー設定へのアクセス
- APIM コンソールの API 管理セクションに移動します。
- メニューから API 基本ポリシーを選択します。
- リストからプロジェクトを選択します。
プロジェクトが選択されると、API 基本ポリシーの設定画面が表示されます。
ステップ 2: ポリシーの追加または削除
現在適用されていないポリシーは、適用不可セクションにリストされています。
ポリシーを適用するには:
- 適用不可セクションのポリシーを見つけます。
- ポリシーの横にあるバツ (x) アイコンをクリックします。
- ポリシーは適用セクションに移動します。
ポリシーを削除するには:
- 適用セクションのポリシーを見つけます。
- マイナス (+) アイコンをクリックします。
- ポリシーは適用不可セクションに戻されます。
ステップ 3: ポリシーの詳細を表示
- 適用セクションにリストされているポリシーをクリックします。
- ポリシーの詳細がページの下部に新しいセクションで表示されます。
- 各ポリシーには独自の設定とパラメータがあります。利用可能な設定フィールドは、特定のポリシータイプによって異なります。各ポリシーのカスタマイズについて詳しくは、ユーザーガイド/APIM コンソールガイド/API ポリシー詳細ガイドを参照してください。
apim-admin ユーザーが中央でポリシーを変更するのを防ぐために、次の 2 つの設定を使用して制御を行うことができます:
- Apply/Unapply Immutable: 有効にすると、これはロック設定であり、apim-admin ユーザー以外の誰も API にポリシーが適用されているかどうかを変更できなくなります。
- Configuration Value Immutable: 有効化されると、これは apim-admin ユーザー以外の誰も API 上のポリシーの構成値を変更できないようにするロック設定です。
ステップ 4: ポリシーのカスタマイズと保存
- 必要に応じてポリシー設定を変更します。変更はその後に作成される新しい API に適用されます。
- 右上の保存ボタンをクリックして変更を適用します。
