管理 Advanced API Security 插件

本页面适用于 Apigee，但不适用于 Apigee Hybrid。

查看 Apigee Edge 文档。

Advanced API Security 会持续监控您的 API，以保护它们免受安全威胁（包括来自恶意客户端和滥用行为的攻击）。Advanced API Security 会分析 API 流量以识别可疑的 API 请求，并提供可以阻止或标记这些请求的工具。此外，Advanced API Security 还会评估您的 API 配置以确保其符合安全标准，并在需要时提供改进建议。

如果您是 Apigee 随用随付客户，则 Advanced API Security 可作为付费插件使用。本主题介绍了如何为符合条件的随用随付环境启用和管理 Advanced API Security 插件。如需详细了解如何在 Apigee 环境中启用插件后使用 Advanced API Security，请参阅 Advanced API Security 概览。

可用情况

Advanced API Security 作为付费插件功能提供，可针对 Apigee 实现中的每个 Apigee 环境进行管理。您可以在任何 Apigee 中间环境或综合环境中启用该插件。您无法在基础环境中启用和使用 Advanced API Security。如需详细了解 Apigee 环境功能，请参阅环境类型比较。

所需的角色和权限

如需获得管理 Advanced API Security 插件所需的权限，请让管理员向您授予项目的 Apigee Environment Admin (apigee.environment.admin) IAM 角色。如需详细了解如何授予角色，请参阅管理访问权限。

此预定义角色包含管理 Advanced API Security 插件所需的权限。如需查看所需的确切权限，请展开所需权限部分：

所需权限

如需管理 Advanced API Security 插件，您需要具备以下权限：

  • apigee.addonsconfig.get
  • apigee.addonsconfig.update

您也可以使用自定义角色或其他预定义角色来获取这些权限。

启用该插件后，可能需要其他角色才能使用 Advanced API Security 执行任务。如需了解详情，请参阅必需的角色。

启用 Advanced API Security 插件

您可以使用 Google Cloud 控制台中的 Apigee 界面或使用 API 为中级或综合 Apigee 环境启用 Advanced API Security 插件，如下所述部分。

Google Cloud 控制台中的 Apigee

如需在 Google Cloud 控制台中启用 Advanced API Security 插件，请执行以下操作：

  1. 在控制台中打开 Apigee 页面。

    前往 Apigee

  2. 选择包含要管理的随用随付组织和环境的项目。
  3. 选择插件 > Advanced API Security 以打开 Advanced API Security 插件页面。
  4. 在管理 Advanced API Security 插件窗格中，选中要在其中启用该插件的环境（或多个环境）对应的复选框。
  5. 点击启用所选项。
  6. 为所选环境启用插件后，环境状态将显示 已启用。
  7. 选择 Advanced API Security 以查看使用安全数据的页面选项，包括评估风险、滥用行为检测、安全报告和安全操作。最多可能需要 10 分钟才能显示 Advanced API Security 数据。

Apigee API

如需使用 Apigee API 启用 Advanced API Security 插件，请输入以下命令：

curl -X POST \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig:setAddonEnablement \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json" \
      -d '{"api_security_enabled":true}'

其中：

  • ORG_NAME 是您要在其中向符合条件的环境添加 Advanced API Security 的 Apigee 随用随付组织的名称。
  • ENV_NAME 是您要启用 Advanced API Security 插件的 Apigee 环境的名称。

启用完成后，点击 Advanced API Security 以查看使用安全数据的页面选项，包括评估风险、滥用行为检测、安全报告和安全操作。最多可能需要 10 分钟才能在界面中显示 Advanced API Security 数据，或者通过 API 调用提供。

Advanced API Security 插件启用过程最多可能需要 15 分钟。启用后，环境的安全数据会保留 14 个月。只要插件已启用，您就可以从控制台中的 Advanced API Security 页面访问环境的历史数据。

开始启用插件后，就会开始计算 Advanced API Security 插件的使用费。

停用 Advanced API Security 插件

您可以使用 Google Cloud 控制台中的 Apigee 界面或使用 API 为中级或综合 Apigee 环境停用 Advanced API Security 插件，如下所述部分。

Cloud 控制台中的 Apigee

如需在 Google Cloud 控制台中停用 Advanced API Security 插件，请执行以下操作：

  1. 在控制台中打开 Apigee 页面。

    前往 Apigee

  2. 选择包含要管理的随用随付组织和环境的项目。
  3. 选择插件 > Advanced API Security 以打开 Advanced API Security 插件页面。
  4. 在管理 Advanced API Security 插件窗格中，选中要在其中停用该插件的环境（或多个环境）对应的复选框。
  5. 点击停用所选项。
  6. 停用完成后，每个环境的状态都会显示 已停用。

Apigee API

如需使用 Apigee API 停用 Advanced API Security 插件，请输入以下命令：

curl -X POST \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig:setAddonEnablement \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json" \
      -d '{"api_security_enabled":false}'

其中：

  • ORG_NAME 是您要在符合条件的环境中停用 Advanced API Security 的 Apigee 随用随付组织的名称。
  • ENV_NAME 是您要停用 Advanced API Security 插件的 Apigee 环境的名称。

在环境中查看 Advanced API Security 插件状态

您可以使用 Google Cloud 控制台中的 Apigee 界面或使用 API 检查中间或综合 Apigee 环境的 Advanced API Security 插件的状态，如以下部分所述。

Google Cloud 控制台中的 Apigee

如需使用 Google Cloud 控制台在环境中查看 Advanced API Security 插件的状态，请执行以下操作：

  1. 在控制台中打开 Apigee 页面。

    前往 Apigee

  2. 选择包含要管理的随用随付组织和环境的项目。
  3. 选择插件 > Advanced API Security 以打开 Advanced API Security 插件页面。
  4. 在管理 Advanced API Security 插件窗格中，系统会显示环境列表。
  5. 在状态列中，您可以查看插件在每个中间环境还是综合环境中是已启用还是已停用。基础环境不会显示这两种状态。

Apigee API

如需使用 Apigee API 查看环境中 Advanced API Security 插件的状态，请输入以下命令：

curl -X GET \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json"

其中：

  • ORG_NAME 是 Apigee 随用随付组织的名称。
  • ENV_NAME 是 Apigee 环境的名称。

响应会返回表示插件当前状态的 ApiSecurityConfig 对象。

管理您的 Advanced API Security 数据

为环境启用 Advanced API Security 插件后，该环境的安全数据会保留 14 个月。您可以通过控制台中的安全报告页面访问环境之前生成的环境安全报告，但无法创建新报告。

如果您在环境中停用 Advanced API Security 插件，则环境的安全数据会在 30 天后删除。如果您在停用后的 30 天内在同一环境中重新启用该插件，则可以在 14 个月的保留期限内重新获得对环境安全数据的访问权限。如果在 30 天后为该环境重新启用插件，则不会恢复任何数据。

如果您希望保留任何环境的安全报告超过 14 个月的保留期，我们建议您导出数据并将其保存在其他位置。您可能还需要在停用插件之前导出 Advanced API Security 数据，或者在停用后 30 天内导出。您可以使用控制台中的安全报告页面中的导出按钮导出安全报告，也可以使用 Security reports API 下载报告。