API エンドポイントの検出
API Securityを使用して、組織内で検出されたAPIエンドポイントを表示できます。NetScalerコンソールは、NetScalerインスタンスとAPIデプロイメントで受信したAPIトラフィックに基づいてAPIエンドポイントを検出します。
NetScaler Consoleの［セキュリティ］ >［APIセキュリティ］>［API検出 ］ページには、検出されたAPIエンドポイントが表示されます。
-
仮想サーバー-［ 仮想サーバー ］タブには、NetScalerインスタンスの仮想サーバーが表示されます。仮想サーバーは、指定された期間の API リクエストを受信すると、このタブに表示されます。
-
APIデプロイメント- このタブには、API定義を使用してNetScaler ConsoleからデプロイされたAPIデプロイメントが表示されます。このタブは、API デプロイが指定された期間の API リクエストを受信したときに API エンドポイントを検出します。API 定義を追加してデプロイするには、「API 定義の追加」と「API 定義のデプロイ」を参照してください。
注：
分析を構成し、仮想サーバーで Web Insightを有効にしてください。 API インスタンスでWeb Insightを有効にするを参照してください。
ポリシーを追加できるのは、[API deployments] タブで検出された API エンドポイントのみです。
API エンドポイントの表示
API Discoveryでは、仮想サーバーまたはAPIデプロイメントを選択すると、NetScaler Console GUIにAPIエンドポイントと次のような詳細が表示されます。
-
メソッド -それは、APIエンドポイントで使用されるメソッドを表示します。たとえば、
GETおよびPOSTメソッド。 -
リクエスト合計 -それは、APIエンドポイント上のAPIリクエストの数を表示します。
-
応答ステータス -それは、各応答ステータスのカウントを表示します。たとえば、
2xx、3xx、4xx、5xxなどです。 -
仕様で見つかりました -この列は API デプロイにのみ表示されます。API 定義に含まれていない内部 API が外部からトラフィックを受け取る場合があります。この列は、API エンドポイントと観測されたメソッドが API 定義の一部であるかどうかを識別するのに役立ちます。
仮想サーバーの API エンドポイントは以下のように利用できます：
API デプロイメントの API エンドポイントは以下のように利用できます：
必要な API エンドポイントを選択して、詳細な分析レポートを表示することもできます。
各セクションの詳細については、「 API 分析を表示する」を参照してください。
検出された API エンドポイントから API 定義を作成
検出された API エンドポイント (API リソースとメソッド) から API 定義を作成するには:
-
[ セキュリティ] > [API セキュリティ] > [API Discovery ] に移動して、仮想サーバーと API デプロイメントのリストを表示します。
-
「 vServers」タブで任意の仮想サーバーをクリックします 。
-
仮想サーバーページには、検出されたエンドポイントのリストが表示されます。任意のエンドポイントを選択し、「 API 定義の作成」をクリックします。
注：
エンドポイントを選択せずに Create API Definitionをクリックすると、すべてのエンドポイントの API 定義を作成するかどうかを確認するポップアップウィンドウが表示されます。すべてのエンドポイントを含む API 定義を作成するには [ はい ] をクリックし、それ以外の場合は [ いいえ] をクリックします。
-
「 API 定義の作成」で、以下を指定します。
-
名前 -API定義の名前。
-
API 定義 -定義には、タイトル、バージョン、ベースパス、およびホストを含める必要があります。[ Host ] フィールドで、ドメイン名または IP アドレスを指定できます。
-
API リソース -定義に複数の API リソースを追加します。各リソースには、パスとサポートされているメソッドがあります。
-
-
「 定義を作成 」をクリックして API 定義を作成します。
注:
API リソースパスを API 定義に追加する前に編集する場合は、API 定義画面の API リソースのソートまたは検索機能を使用してください。
たとえば、「/api/products/123-3243-2344334/views」という名前の API リソースを考えてみましょう。パスセグメント「123-3243-2344334」は可変プロダクト ID です。API リソースをソートしたり、リソースパスを「/api/products/ {id} /views」として追加したり、「/api/products/123-3243-2344334/views」などの ID を持つすべての API エンドポイントを削除したりできるようになりました。
検出された API エンドポイントで既存の API 定義を更新する
既存の API 定義を API エンドポイント (API リソースとメソッド) で更新するには:
-
[ セキュリティ] > [API セキュリティ] > [API Discovery ] に移動して、仮想サーバーと API デプロイメントのリストを表示します。
-
「 vServers」タブで任意の仮想サーバーをクリックします 。
-
仮想サーバーページには、検出されたエンドポイントのリストが表示されます。既存の API 定義に追加するエンドポイントを選択します。「 既存の API 定義を更新」をクリックします。
-
「既存の API 定義を選択 」ドロップダウンリストから、更新する API 定義を選択します。[ 定義を更新] をクリックします。
- 「 既存の API 定義の更新 」ページが表示されます。「 API リソース 」セクションには、次の表が表示されます。
-
追加リソース -選択した API エンドポイント
-
既存のリソース -API 定義ですでに使用可能な API エンドポイント
注：
同じ API エンドポイントが [ 追加リソース] と [ **既存リソース**] で利用できる場合、エンドポイントは API 定義に 1 回だけ追加されます。
-
- [ 定義を更新] をクリックします。