Sense からの通知の取得

現在、Apigee Edge のドキュメントを表示しています。
Apigee X のドキュメントをご確認ください
情報

望ましくない可能性のある API リクエストのリストで通知されるように Apigee Sense を構成できます。通知を設定すると、Apigee Sense は指定された Webhook URI に 5 分ごとにレポートを送信します。

Apigee Sense は、Webhook URI を使用して JSON 形式の文字列を送信します(文字列を解析して JSON に変換するコードが必要です)。次の例では、読みやすくするために文字列を JSON 形式でレポートしています。

{
    "text": {
        "metadata": {
            "org": "my-org",
            "env": "prod",
            "reportTimestamp": "2018-10-09T17:25:12Z",
            "messageId": "1539105912220"
        },
        "totalNumberOfBots": 1,
        "bots": [
            {
                "ipAddress": "11.111.111.11",
                "botDetectedLast": "2018-10-0917:04:48Z",
                "ipIsp": "Their ISP",
                "ipCountry": "United States",
                "botReason": [
                    "Flooder",
                    "Content Robber"
                ],
                "callCount": "274529",
                "topUrl": "/v1/my/url",
                "ipCity": "Los Angeles"
            }
        ]
    }
}

このレポートでは、API に対する望ましくない攻撃の可能性について、次の情報を確認できます。

  • リクエストが報告された Apigee の組織と環境。
  • レポートのタイムスタンプ。
  • レポート メッセージの ID。
  • 望ましくないリクエストを行う IP アドレスの数。
  • 望ましくないリクエスト(bot など)を行う IP アドレスのクライアント データの配列。クライアントごとに、レポートには次の情報が表示されます。

    お客様の特徴 説明
    ipAddress クライアントの IP アドレス。
    botDetectedLast クライアントからの最新のリクエストのタイムスタンプ。
    ipIsp リクエストを行うクライアントの ISP。
    ipCountry クライアントからのリクエスト送信元の国。
    botReason この IP アドレスからのリクエストに一致する Apigee Sense 検出ルール。
    callCount この IP アドレスからのリクエストの数。
    topUrl クライアント IP でリクエストされる最も一般的な URL。これは、クライアントがリクエストした API です。
    ipCity リクエストを受信した都市。

通知を設定するには

  1. New Edge エクスペリエンスを開きます。
  2. New Edge エクスペリエンスで、[Analyze] メニュー、[Sense] の順にクリックします。
  3. [設定] メニューをクリックします。
  4. [設定] ページで、通知を構成するための値を入力します。

    設定 説明
    通知 クリックすると、この通知が有効または無効になります。
    URI Apigee Sense が通知の送信時に使用する URI。これは通常、着信 Webhook を受け入れるモニタリング システムです。Apigee Sense からのレポートは、この URI に送信されます。
    API キー名 (省略可)Apigee Sense がシステムでの認証時に使用するキー名。API キーを使用してセキュリティを強化します。
    API キー値 (省略可)Apigee Sense がシステムで認証するときに使用する Key-Value。API キーを使用してセキュリティを強化します。
    IP の最大数 レポートに含めるクライアント IP アドレスの最大数(1 ~ 300)。Apigee Sense には、リクエストの数が多い順に、ここで指定した IP の数までの IP アドレスが含まれています。