管理 Apigee API Analytics 外掛程式

本頁面適用於 Apigee，但不適用於 Apigee Hybrid。

查看 Apigee Edge 說明文件。

Apigee API Analytics 會收集並計算透過 API Proxy 傳送的大量資訊。您可以在 Apigee UI 中使用圖表和圖表呈現這類資料，也可以下載原始資料，以便使用 Apigee API 進行離線分析。如要進一步瞭解可透過 Apigee API Analytics 收集及分析的資料類型，請參閱「Apigee Analytics 簡介」。

如果您是 Apigee 即付即用客戶，Apigee API Analytics 可做為付費外掛程式使用。本主題說明如何啟用及管理 Apigee API Analytics 外掛程式，適用於符合資格的付費即用環境。如要進一步瞭解在 Apigee 環境中啟用外掛程式後，如何使用 Apigee API Analytics 資訊主頁，請參閱「 使用 Analytics 資訊主頁」一文。

可用性

Apigee API Analytics 是付費外掛程式功能，可為 Apigee 導入的每個 Apigee 環境進行管理。您可以在任何 Apigee 中等或全方位環境中啟用外掛程式。您無法在 Base 環境中啟用及使用 Apigee API Analytics。如要進一步瞭解 Apigee 環境功能，請參閱「環境類型比較」。

必要角色和權限

如要取得管理 Apigee API Analytics 外掛程式的權限，請要求管理員為您授予專案的 Apigee 環境管理員 (apigee.environment.admin) IAM 角色。如要進一步瞭解如何授予角色，請參閱「管理專案、資料夾和機構的存取權」。

這個預先定義的角色具備管理 Apigee API Analytics 外掛程式所需的權限。如要查看確切的必要權限，請展開「必要權限」部分：

所需權限

如要管理 Apigee API Analytics 外掛程式，您必須具備下列權限：

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

您或許還可透過自訂角色或其他預先定義的角色取得這些權限。

啟用 Apigee API Analytics 外掛程式

您可以使用 Google Cloud 主控台中的 Apigee UI 或 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 指標」，即可查看 Analytics 資料。 系統最多可能需要 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 是 Apigee 預付制機構的名稱，您可以在該機構中將 Analytics 新增至符合資格的環境。
  • ENV_NAME 是您要啟用 Apigee API Analytics 外掛程式的 Apigee 環境名稱。

啟用完成後，請依序選取「Analytics」>「API 指標」，查看 Apigee API Analytics 資料。 系統最多可能需要 10 分鐘，才能在 UI 中顯示或透過 API 呼叫提供數據。

Apigee API Analytics 外掛程式啟用程序最多可能需要 15 分鐘才能完成。啟用後，環境的數據分析資料將保留 14 個月。只要啟用外掛程式，您就可以在主控台的「API 指標」頁面中存取環境的歷來資料。

啟用 Apigee API Analytics 外掛程式後，就會開始計費。

停用 Apigee API Analytics 外掛程式

您可以使用 Google Cloud 主控台中的 Apigee UI 或 API，為中級或進階 Apigee 環境停用 Apigee API Analytics 外掛程式，詳情請參閱下文。

如果您在環境中啟用了 Advanced API Security 外掛程式，則必須先停用 Advanced API Security 外掛程式，才能停用 Apigee API Analytics 外掛程式。如果未停用 Advanced API Security 外掛程式，則在該環境中停用 Apigee API Analytics 的任何要求都會失敗。如果您在環境中啟用 Advanced API Security 外掛程式，該外掛程式會顯示在「Manage Apigee API Analytics add-on」窗格中的「Other enabled add-ons」欄中。

如要停用外掛程式，請參閱「 停用進階 API 安全性外掛程式」。

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 是 Apigee 預付制機構的名稱，您可以在該機構中將 Analytics 新增至符合資格的環境。
  • ENV_NAME 是您要啟用 Apigee API Analytics 外掛程式的 Apigee 環境名稱。

查看環境中的 Apigee API Analytics 外掛程式狀態

您可以使用 Google Cloud 主控台中的 Apigee UI 或 API，查看 Apigee API Analytics 外掛程式針對中級或進階 Apigee 環境的狀態，如以下各節所述。

Google Cloud 控制台中的 Apigee

如要使用 Google Cloud 控制台查看環境中的 Apigee API Analytics 外掛程式的狀態，請按照下列步驟操作：

  1. 在控制台中開啟 Apigee 頁面。

    前往 Apigee

  2. 選取使用預付費機構組織和環境的專案。
  3. 依序選取「外掛程式」>「Analytics」，開啟「Analytics 外掛程式」頁面。
  4. 在「管理 Apigee API Analytics 外掛程式」窗格中，會顯示環境清單。
  5. 您可以在「狀態」欄中查看各個 Intermediate 或 Comprehensive 環境中的外掛程式是否已啟用或停用。基本環境不會顯示任何狀態。

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 匯出資料」。