APIエンドポイントの検出
API Securityを使用して、組織内の検出されたAPIエンドポイントを表示できます。NetScaler Consoleは、NetScalerインスタンスおよびAPI展開で受信したAPIトラフィックに基づいてAPIエンドポイントを検出します。
NetScaler Consoleの Security > API Security > API Discovery ページに、検出されたAPIエンドポイントが表示されます。
注：
-
仮想サーバーで分析を設定し、Web Insightsを有効にしてください。「APIインスタンスでWeb Insightを有効にする」を参照してください。
-
API展開 タブの下で検出された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エンドポイント(/en-us/netscaler-console-service/media/vserver-api-endpoints.png)
API展開におけるAPIエンドポイントは、以下のとおり利用可能です。
仮想サーバー内のAPIエンドポイント(/en-us/netscaler-console-service/media/api-deployment-endpoints.png)
必要なAPIエンドポイントを選択して、詳細な分析レポートを表示することもできます。
詳細なAPIエンドポイントレポート(/en-us/netscaler-console-service/media/detailed-api-endpoint-report.png)
各セクションの詳細については、API分析の表示を参照してください。
検出されたAPIエンドポイントからAPI定義を作成する
検出されたAPIエンドポイント（APIリソースとメソッド）からAPI定義を作成するには：
-
Security > API Security > API Discovery に移動して、仮想サーバーとAPI展開のリストを表示します。
-
VServers タブで任意の仮想サーバーをクリックします。
-
仮想サーバーページに検出されたエンドポイントのリストが表示されます。任意のエンドポイントを選択し、Create API Definition をクリックします。
API定義の更新(/en-us/netscaler-console-service/media/api-gateway-create-api-definition.png)
注：
エンドポイントを選択せずに Create API Definition をクリックすると、すべてのエンドポイントに対してAPI定義を作成するかどうかを確認するポップアップウィンドウが表示されます。すべてのエンドポイントでAPI定義を作成するには Yes をクリックし、それ以外の場合は No をクリックします。
すべてのエンドポイントのポップアップメッセージ(/en-us/netscaler-console-service/media/api-definition-all-endpoints-msg.png)
-
「API定義の作成」で、以下を指定します:
-
名前 - API定義の名前。
-
API定義 - 定義には、タイトル、バージョン、ベースパス、ホストを含める必要があります。「ホスト」フィールドには、ドメイン名またはIPアドレスを指定できます。
-
APIリソース - 定義に複数のAPIリソースを追加します。各リソースにはパスとサポートされているメソッドがあります。
-
-
「定義の作成」をクリックして、API定義を作成します。
注:
APIリソースパスをAPI定義に追加する前に編集する場合は、API定義画面でAPIリソースの並べ替え機能または検索機能を使用します。
たとえば、「/api/products/123-3243-2344334/reviews」という名前のAPIリソースを考えます。ここで、パスセグメント「123-3243-2344334」は可変の製品IDです。APIリソースを並べ替えて、リソースパスを「/api/products/{id}/reviews」として追加し、「/api/products/123-3243-2344334/reviews」のようなIDを持つすべてのAPIエンドポイントを削除できます。
検出されたAPIエンドポイントで既存のAPI定義を更新する
既存のAPI定義をAPIエンドポイント (APIリソースとメソッド) で更新するには:
-
「Security > API Security > API Discovery」に移動して、仮想サーバーとAPI展開のリストを表示します。
-
「VServers」タブで任意の仮想サーバーをクリックします。
-
仮想サーバーページには、検出されたエンドポイントのリストが表示されます。既存のAPI定義に追加するエンドポイントを選択します。「Update existing API Definition」をクリックします。
-
「既存のAPI定義を選択」ドロップダウンリストから、更新するAPI定義を選択します。「定義を更新」をクリックします。
-
「既存のAPI定義を更新」ページが表示されます。「APIリソース」セクションには、次の表が表示されます。
-
追加されたリソース - 選択したAPIエンドポイント
-
既存のリソース - API定義ですでに利用可能なAPIエンドポイント
注:同じAPIエンドポイントが「追加されたリソース」と「既存のリソース」の両方で利用可能な場合、そのエンドポイントはAPI定義に1回だけ追加されます。 -
-
「定義を更新」をクリックします。