接收 Sense 通知

您正在查看 Apigee Edge 說明文件。
前往 Apigee X 說明文件
info

您可以設定 Apigee Sense,在偵測到可能不必要的 API 要求時,通知您。設定通知後,Apigee Sense 會每 5 分鐘將報表傳送至您指定的 webhook URI。

使用 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 要求的最常見網址。這是用戶端要求的 API。
    ipCity 收到要求的城市。

如何設定通知

  1. 開啟新版 Edge 服務
  2. 在 New Edge 服務中,按一下「Analyze」選單,然後點選「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 位址數量。