接收 Sense 通知

您正在查看 Apigee Edge 說明文件。
查看 Apigee X 說明文件
資訊

您可以設定讓 Apigee Sense 在偵測到疑似不需要的 API 要求時通知您。設定通知後,Apigee Sense 每隔 5 分鐘就會傳送報表至您指定的 Webhook URI。

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 位址數量。
  • IP 位址發出可能不需要的要求 (例如漫遊器) 的用戶端資料陣列。針對各個客戶,這份報表包含:

    客戶特色 說明
    ipAddress 用戶端的 IP 位址
    botDetectedLast 用戶端最近要求的時間戳記。
    ipIsp 發出要求的客戶 ISP。
    ipCountry 用戶端發出要求的國家/地區。
    botReason Apigee Sense 偵測規則符合來自這個 IP 位址的要求。
    callCount 來自這個 IP 位址的要求數量。
    topUrl 用戶端 IP 最常要求的網址。這是用戶端要求的 API。
    ipCity 接收要求的來源城市。

如何設定通知

  1. 開啟 New Edge 服務
  2. 在新版 Edge 服務中,依序按一下「分析」選單和「Sense」。
  3. 按一下「設定」選單。
  4. 在「設定」頁面中輸入值,即可設定通知:

    設定 說明
    通知 按一下即可啟用或停用這則通知。
    URI 您希望 Apigee Sense 在傳送通知時使用的 URI。這個監控系統通常會接受連入 Webhook。系統會將 Apigee Sense 的報表傳送至這個 URI。
    API 金鑰名稱 選用設定。在向系統進行驗證時,Apigee Sense 應使用的重要名稱。使用 API 金鑰提升安全性。
    API 金鑰值 選用設定。在向系統進行驗證時,Apigee Sense 應使用的重要價值。使用 API 金鑰提升安全性。
    IP 數量上限 報表中要包含的用戶端 IP 位址數量上限 (從 1 到 300 個)。Apigee Sense 會依據您在這裡指定的 IP 數量,依序處理可疑要求數量的 IP 位址,例如要求數最多到最少要求。