Sense からの通知の取得

不要な API リクエストのリストを通知するように Apigee Sense を構成できます。通知を設定すると、Apigee Sense は指定した WebHook URI に 5 分ごとにレポートを送信します。

Webhook URI を使用して、Apigee Sense は 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 アドレスの数。
  • 潜在的に望ましくないリクエスト(ボットなど)を引き起こす IP アドレスのクライアント データの配列。各クライアントについて、レポートには以下が含まれます。

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

通知の設定方法

  1. [New Edge experience] を開きます。
  2. New Edge エクスペリエンスで、[Analyze] メニューをクリックしてから、[Sense] をクリックします。
  3. [Settings] メニューをクリックします。
  4. [Settings] ページで、通知を構成する値を入力します。

    設定 説明
    通知 この通知を有効または無効にする場合にクリックします。
    URI Apigee Sense が通知を送信する際に使用する URI。これは通常、入ってくる Web フックを受け入れるモニタリング システムです。Apigee Sense からのレポートはこの URI に送られます。
    API キー名 省略可。キー名 Apigee Sense は、システムで認証するときに使用する必要があります。セキュリティを強化するには、API キーを使用します。
    API キー値 省略可。キー値 Apigee Sense は、システムで認証するときに使用する必要があります。セキュリティを強化するには、API キーを使用します。
    IP の最大数 レポートに含めるクライアント IP アドレスの最大数(1〜300)。Apigee Sense には、ほとんどのリクエストから、最低でもここで指定した IP 数まで、疑わしいリクエスト数の順で IP アドレスが含まれます。