接收来自 Sense 的通知

您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档。 信息

您可以配置 Apigee Sense，以列出检测到的可能不需要的 API 请求。设置通知后，Apigee Sense 会每 5 分钟向您指定的网络钩子 URI 发送一次报告。

Apigee Sense 会使用网络钩子 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	来自此 IP 地址的请求符合的 Apigee Sense 检测规则。
  callCount	来自此 IP 地址的请求数。
  topUrl	客户端 IP 请求的最常见网址。这是客户端请求的 API。
  ipCity	收到请求所在的城市。

设置通知

1. 打开新版 Edge 体验。
2. 在新版 Edge 中，点击 Analyze 菜单，然后点击 Sense。
3. 点击设置菜单。

4. 在设置页面上，输入相应值以配置通知：

   设置	说明
   通知	点击可启用或停用此通知。
   URI	您希望 Apigee Sense 在发送通知时使用的 URI。这通常是一个接受传入的网络钩子的监控系统。Apigee Sense 的报告将发送到此 URI。
   API 密钥名称	可选。Apigee Sense 在向您的系统进行身份验证时应使用的密钥名。使用 API 密钥可提高安全性。
   API 密钥值	可选。Apigee Sense 在向您的系统进行身份验证时应使用键值对。使用 API 密钥可提高安全性。
   IP 数量上限	报告中可包含的客户端 IP 地址的数量上限（1 到 300 个）。Apigee Sense 会按照可疑请求数量（从最多到最少，一直到您在此处指定的 IP 数量）添加 IP 地址。