安全提醒

本页面适用于 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 文档。

借助 Advanced API Security Alerts，您可以针对与 API 安全性相关的事件（例如，安全分数变化或检测到的 API 滥用行为突发事件）创建提醒。您可以使用 Cloud Monitoring 创建提醒。您可以将提醒配置为在触发提醒时通过短信、电子邮件或其他渠道向您发送通知。如需详细了解如何创建提醒，请参阅创建指标阈值提醒政策。

所需的角色

如需在 Cloud Monitoring 中设置提醒和通知渠道，您需要具有以下角色：

  • roles/monitoring.alertPolicyEditor
  • roles/monitoring.notificationChannelEditor

限制

关于提醒，存在以下限制：

  • 所有 Apigee 订阅级别的提醒政策的数量上限为 500。
  • 指标数据会存储 6 周。
  • 指标阈值条件评估的最长时间段为 23 小时 30 分钟。
  • 从触发提醒的事件发生到创建提醒和发送通知，最多可能有 4 分钟的延迟。

如需查看提醒的完整列表，请参阅提醒限制。

以下部分举例说明了如何创建提醒。

示例：创建代理安全分数降低提醒

此示例会在代理安全分数低于指定阈值时创建提醒。如需创建提醒，请执行以下步骤：

  1. 在 Google Cloud 控制台中打开创建提醒政策页面。

  2. 点击选择指标。
  3. 取消选择仅显示有效的资源和指标。

    注意：如果贵组织中没有最近的 API 流量数据，则下一步中的指标不会显示，除非取消选择此选项。

  4. 按如下方式选择指标：
    1. 选择 Apigee API Security 配置文件环境关联。
    2. 在右侧打开的窗格中，选择安全性
    3. 在右边的下一个窗格中，选择 Apigee API 代理的安全分数。
    4. 点击应用
  5. （可选）如需限制提醒数据（例如，限制为指定环境），您可以按如下方式创建过滤条件：
    1. 在添加过滤条件 > 新建过滤条件下，点击过滤条件字段，然后选择要作为过滤依据的资源标签，例如 env。
    2. 在比较条件字段中，选择一个比较条件，例如 =。
    3. 在值字段中，选择资源标签值，例如环境名称。

    使用此过滤条件时，只有符合过滤条件的数据才会触发提醒。如需查看可用过滤条件的列表，请参阅过滤条件。

  6. 在转换数据下的滚动窗口函数字段中，选择总和。
  7. 点击下一步。
  8. 在配置提醒触发器窗格中，设置以下内容：
    • 在条件类型下，选择阈值。
    • 在提醒触发器下，选择任何时序违反。
    • 在阈值位置下，选择低于阈值。
    • 在阈值字段中，输入触发提醒的阈值，例如 600。
  9. 点击下一步。
  10. 在配置通知字段中，点击通知渠道字段，然后选择通知的渠道，例如短信或电子邮件。如果您尚未配置任何渠道，请点击管理通知渠道并添加一个或多个渠道。
  11. 点击确定。
  12. 在文档字段中，输入您要随通知一起发送的任何文本，例如提醒触发原因的说明。例如，您可以输入“安全分数低于 600”。
  13. 在为提醒政策命名下，输入提醒政策的名称。
  14. 点击下一步，然后查看提醒政策的详细信息。
  15. 如果一切正常，请点击创建政策以创建提醒政策。

示例：创建当检测规则中检测到的滥用行为流量增加时触发的提醒

此示例展示了如何在检测到有滥用流量的请求数量超过任何单个检测规则的指定阈值时创建警报。如需创建提醒，请执行以下步骤：

  1. 在 Google Cloud 控制台中打开创建提醒政策页面。

    “创建提醒政策”页面

  2. 点击选择指标。
  3. 取消选择仅显示有效的资源和指标。

    注意：如果贵组织中没有最近的 API 流量数据，则下一步中的指标不会显示，除非取消选择此选项。

  4. 按如下方式选择指标：
    1. 选择 Apigee API Security 检测规则。
    2. 在右侧打开的窗格中，选择安全性
    3. 在右侧的下一个窗格中，选择 Apigee API Security 检测到的请求数(按规则分组)。
    4. 点击应用
  5. （可选）如需限制提醒数据（例如，限制为指定环境），您可以按如下方式创建过滤条件：
    1. 在添加过滤条件 > 新建过滤条件下，点击过滤条件字段，然后选择要作为过滤依据的资源标签，例如 env。
    2. 在比较条件字段中，选择一个比较条件，例如 =。
    3. 在值字段中，选择资源标签值，例如环境名称。

    使用此过滤条件时，只有符合过滤条件的数据（例如某个环境中的数据）才会触发提醒。如需查看可用过滤条件的列表，请参阅过滤条件。

  6. 在转换数据下的滚动窗口函数字段中，选择总和。
  7. 点击下一步。
  8. 在配置提醒触发器窗格中，设置以下内容：
    • 在条件类型下，选择阈值。
    • 在提醒触发器下，选择任何时序违反。
    • 在阈值位置下，选择高于阈值。
    • 在阈值字段中，输入触发提醒的阈值，例如 100。
  9. 点击下一步。
  10. 在配置通知字段中，点击通知渠道字段，然后选择通知的渠道，例如短信或电子邮件。如果您尚未配置任何渠道，请点击管理通知渠道并添加一个或多个渠道。
  11. 点击确定。
  12. 在文档字段中，输入您要随通知一起发送的任何文本，例如提醒触发原因的说明。例如，您可以输入“检测到 $(resource.label.env) 的滥用流量超过 100”。此示例使用 $(resource.label.env) 标签，该标签显示其数据触发了提醒的环境。
  13. 在为提醒政策命名下，输入提醒政策的名称。
  14. 点击下一步，然后查看提醒政策的详细信息。
  15. 如果一切正常，请点击创建政策以创建提醒政策。

安全提醒的指标

下表介绍了用于创建安全提醒的可用指标：

资源 指标 说明 支持的过滤条件
Apigee 环境 Apigee API Security 请求数：
apigee.googleapis.com/security/request_count		 自上次采样以来，Advanced API Security 处理的 API 请求数。 location、org、env、proxy
Apigee 环境 Apigee API Security 检测到的请求数：
apigee.googleapis.com/security/detected_request_count		 自上次采样以来，Advanced API Security 滥用行为检测检测到的 API 请求数。 location、org、env、proxy
Apigee API Security 检测规则 Apigee API Security 检测到的请求数（按规则分组）：
apigee.googleapis.com/security/detected_request_count_by_rule		 自上次采样以来，Advanced API Security 滥用行为检测检测到的 API 请求数（按检测规则分组）。 location、org、env、proxy、detection_rule
Apigee API Security 突发事件 Apigee API Security 突发事件请求数：
apigee.googleapis.com/security/incident_request_count		 检测到属于 API Security 突发事件的 API 请求数。此值每小时测量一次。 location、org、env、proxy
Apigee API Security 突发事件 Apigee API Security 突发事件请求数（按检测规则分组）：
apigee.googleapis.com/security/incident_request_count_by_rule		 检测到属于 Security 突发事件的 API 请求数（按检测规则分组）。此值每小时测量一次。 location、org、env、incident_id、detection_rule
Apigee API Security 配置文件环境关联 Apigee API 来源的安全分数：
apigee.googleapis.com/security/source_score		 基于 Advanced API Security 来源评估得出的 Apigee API 代理当前的安全分数。此值至少每 3 小时测量一次。 location、org、env、profile
Apigee API Security 配置文件环境关联 Apigee API 代理的安全分数：
apigee.googleapis.com/security/proxy_score		 基于 Advanced API Security 代理评估得出的 Apigee API 代理当前的安全分数。此值至少每 3 小时测量一次。 location、org、env、profile、proxy
Apigee API Security 配置文件环境关联 Apigee API 目标的安全分数：
apigee.googleapis.com/security/target_score		 基于 Advanced API Security 目标评估得出的 Apigee API 代理当前的安全分数。此值至少每 3 小时测量一次。 location、org、env、profile、target_server
Apigee API Security 配置文件环境关联 Apigee 环境的安全分数：
apigee.googleapis.com/security/environment_score		 基于 Advanced API Security 来源、代理和目标评估得出的 Apigee 环境当前的安全总分。 此值至少每 3 小时测量一次。 location、org、env、profile

过滤条件

过滤标签 说明
location 资源的位置：始终为全球。
org Apigee 组织名称
env Apigee 环境名称
配置文件 Apigee API Security 配置文件名称
proxy Apigee API 代理名称
target_server Apigee 目标服务器名称
detection_rule Apigee API Security 检测规则名称