管理 Apigee API Analytics 插件

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

查看 Apigee Edge 文档。

Apigee API Analytics 会收集并计算流经 API 代理的大量信息。 您可以使用 Apigee 界面中的图形和图表直观呈现这些数据，也可以使用 Apigee API 下载原始数据，以供离线分析。如需详细了解可以使用 Apigee API Analytics 收集和分析的数据类型，请参阅 Apigee Analytics 概览。

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

可用情况

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

所需的角色和权限

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

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

所需权限

需要以下权限才能管理 Apigee API Analytics 插件：

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

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

启用 Apigee API Analytics 插件

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

Google Cloud 控制台中的 Apigee

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

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

    前往 Apigee

  2. 选择包含要管理的随用随付组织和环境的项目。
  3. 选择插件 > Analytics，以打开 Analytics 插件页面。
  4. 在管理 Apigee API Analytics 插件窗格中，选中要启用该插件的环境（或多个环境）对应的复选框。
  5. 点击启用所选项。
  6. 为所选环境启用插件后，环境状态将显示 已启用。
  7. 如需查看 Apigee API Analytics 数据，请选择 Analytics > API 指标以查看分析数据。 分析数据最多可能需要 10 分钟才会显示。

Apigee API

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

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 '{"analyticsEnabled":true}'

其中：

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

完成启用后，选择 Analytics > API 指标，以查看 Apigee API Analytics 数据。分析数据最多可能需要 10 分钟才会显示在界面中，或通过 API 调用提供。

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

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

停用 Apigee API Analytics 插件

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

如果您在环境中启用了 Advanced API Security 插件，则必须先停用 Advanced API Security 插件，然后才能停用 Apigee API Analytics 插件。如果 Advanced API Security 插件未停用，则环境中停用 Apigee API Analytics 的任何请求都将失败。 如果您的环境中启用了 Advanced API Security 插件，它将显示在管理 Apigee API Analytics 插件窗格的其他启用的插件列中。

要停用该插件，请参阅停用 Advanced API Security 插件。

Cloud 控制台中的 Apigee

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

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

    前往 Apigee

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

Apigee API

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

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 '{"analyticsEnabled":false}'

其中：

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

在环境中查看 Apigee API Analytics 插件状态

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

Google Cloud 控制台中的 Apigee

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

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

    前往 Apigee

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

Apigee API

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

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 环境的名称。

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

管理您的 Apigee API Analytics 数据

为环境启用 Apigee API Analytics 插件后，该环境的分析数据会保留 14 个月。只要插件已启用，您就可以从控制台中的 API 指标页面访问环境的历史分析数据。

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

如果您希望在超过 14 个月的保留期限后保留任何环境的分析数据，我们建议您导出数据并将其保存在其他位置。您还可以在停用 Apigee API Analytics 插件之前，或者在停用后的 30 天期限内导出 Analytics 数据。如需了解详情，请参阅从 Analytics 导出数据。