管理進階 API 安全性外掛程式

本頁內容適用於 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 中等或全方位環境中啟用外掛程式。您無法在 Base 環境中啟用及使用 Advanced API Security。如要進一步瞭解 Apigee 環境功能，請參閱「環境類型比較」。

必要角色和權限

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

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

所需權限

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

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

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

啟用外掛程式後，您可能需要其他角色才能使用進階 API 安全防護執行工作。詳情請參閱「必要的角色」。

啟用 Advanced API Security 外掛程式

您可以透過 Google Cloud 控制台的 Apigee UI 或 API，為中級或全面 Apigee 環境啟用進階 API 安全性外掛程式，詳情請參閱下列章節。

Apigee in Google Cloud console

如要在 Google Cloud 控制台中啟用 Advanced API Security 外掛程式，請按照下列步驟操作：

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

    前往 Apigee

  2. 選取含有隨用隨付機構和要管理環境的專案。
  3. 依序選取「外掛程式」>「Advanced API Security」，開啟「Advanced API Security 外掛程式」頁面。
  4. 在「管理進階 API 安全防護外掛程式」窗格中，選取要啟用外掛程式的環境 (或多個環境) 核取方塊。
  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 '{"apiSecurityEnabled":true}'

其中：

  • ORG_NAME 是 Apigee 隨用隨付機構的名稱，您要將進階 API 安全防護新增至符合資格的環境。
  • ENV_NAME 是您要啟用 Advanced API Security 外掛程式的 Apigee 環境名稱。

啟用完成後，按一下「Advanced API Security」，即可查看使用安全資料的頁面選項， 包括「風險評估」、「濫用行為偵測」、「安全報告」和「安全措施」。 進階 API 安全性資料最多需要 10 分鐘，才會顯示在 UI 中，或可透過 API 呼叫取得。

啟用 Advanced API Security 外掛程式的程序最多可能需要 15 分鐘。啟用後，系統會保留環境的安全資料 14 個月。只要啟用外掛程式，您就能在控制台的「進階 API 安全性」頁面存取環境的歷史資料。

啟用 Advanced API Security 外掛程式後，系統就會開始計費。

停用 Advanced API Security 外掛程式

如要為「中級」或「全面」 Apigee 環境停用 Advanced API Security 外掛程式，請按照下列各節說明，使用 Google Cloud 控制台中的 Apigee UI 或 API 進行操作。

Cloud 控制台中的 Apigee

如要在 Google Cloud 控制台中停用 Advanced API Security 外掛程式，請按照下列步驟操作：

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

    前往 Apigee

  2. 選取含有隨用隨付機構和要管理環境的專案。
  3. 依序選取「外掛程式」>「Advanced API Security」，開啟「Advanced API Security 外掛程式」頁面。
  4. 在「管理進階 API 安全性外掛程式」窗格中，選取要停用外掛程式的環境 (或多個環境) 核取方塊。
  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 '{"apiSecurityEnabled":false}'

其中：

  • ORG_NAME 是 Apigee 隨用隨付方案機構的名稱，您要在符合資格的環境中停用 Advanced API Security。
  • ENV_NAME 是要停用 Advanced API Security 外掛程式的 Apigee 環境名稱。

查看環境中的 Advanced API Security 外掛程式狀態

如要檢查 Intermediate 或 Comprehensive Apigee 環境的 Advanced API Security 外掛程式狀態，請使用 Google Cloud 控制台中的 Apigee UI 或 API，詳情請參閱下列章節。

Apigee in Google Cloud console

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

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

    前往 Apigee

  2. 選取含有隨用隨付機構和要管理環境的專案。
  3. 依序選取「外掛程式」>「Advanced API Security」，開啟「Advanced API Security 外掛程式」頁面。
  4. 「管理進階 API 安全性外掛程式」窗格會顯示環境清單。
  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 物件，代表外掛程式的目前狀態。

管理進階 API 安全性資料

為環境啟用 Advanced API Security 外掛程式後，系統會保留該環境的安全性資料 14 個月。您可以在管理中心的「安全性報告」頁面存取環境先前產生的安全性報告，但無法建立新報告。

如果您在環境中停用 Advanced API Security 外掛程式，系統會在 30 天後刪除該環境的安全資料。如果在停用外掛程式後 30 天內，於相同環境中重新啟用，您就能在 14 個月的保留期限內，重新存取該環境的安全防護資料。如果 30 天後重新啟用環境的外掛程式，系統不會還原任何資料。

如要將任何環境的安全報告保留超過 14 個月，建議您匯出資料並儲存到其他位置。您也可以在停用外掛程式前，或停用後的 30 天內，匯出進階 API 安全防護資料。如要匯出安全性報表，請在控制台的「安全性報表」頁面上按一下「匯出」按鈕，或使用 Security reports API 下載報表。