本頁面適用於 Apigee,但不適用於 Apigee Hybrid。
查看
Apigee Edge 說明文件。
Advanced API Security 會持續監控 API,保護 API 免於遭受安全威脅,包括惡意用戶端的攻擊和濫用行為。Advanced API Security 會分析 API 流量,識別可疑的 API 要求,並提供可封鎖或標示這些要求的工具。此外,Advanced API Security 會評估 API 設定,確保符合安全性標準,並在必要時提供改善建議。
如果您是 Apigee 按量付費客戶,Advanced API Security 可做為付費加購項目提供。本主題說明如何為符合資格的「付費即用」環境啟用及管理進階 API 安全性外掛程式。如要進一步瞭解在 Apigee 環境中啟用外掛程式後,如何使用 Advanced API Security,請參閱「 Advanced API Security 總覽」。
可用性
Advanced API Security 是付費的附加功能,可為 Apigee 導入的每個 Apigee 環境進行管理。您可以在任何 Apigee 中等或全方位環境中啟用外掛程式。您無法在Base 環境中啟用及使用進階 API 安全性。如要進一步瞭解 Apigee 環境功能,請參閱「環境類型比較」。
必要角色和權限
如要取得管理進階 API 安全性外掛程式所需的權限,請要求管理員為您授予專案的 Apigee 環境管理員 (apigee.environment.admin
) IAM 角色。如要進一步瞭解如何授予角色,請參閱「管理專案、資料夾和機構的存取權」。
這個預先定義的角色具備管理進階 API 安全性外掛程式所需的權限。如要查看確切的必要權限,請展開「必要權限」部分:
所需權限
如要管理進階 API 安全性外掛程式,您必須具備下列權限:
-
apigee.addonsconfig.get
-
apigee.addonsconfig.update
啟用外掛程式後,您可能需要其他角色才能使用進階 API 安全性功能執行工作。詳情請參閱「必要角色」。
啟用進階 API 安全性外掛程式
您可以使用 Google Cloud 主控台中的 Apigee UI 或 API,為中階或完整 Apigee 環境啟用進階 API 安全性外掛程式,詳情請參閱下文。
Google Cloud 控制台中的 Apigee
如要在 Google Cloud 控制台中啟用進階 API 安全性外掛程式,請按照下列步驟操作:
- 在控制台中開啟 Apigee 頁面。
- 選取使用預付費機構組織和您要管理的環境的專案。
- 依序選取「外掛程式」>「Advanced API Security」,即可開啟「Advanced API Security 外掛程式」頁面。
- 在「管理進階 API 安全防護加購項目」窗格中,選取要啟用加購項目的環境 (或多個環境) 核取方塊。
- 按一下「啟用所選項目」。
- 所選環境啟用完成後,「環境狀態」會顯示 「已啟用」。
- 選取「Advanced API Security」即可查看使用安全性資料的頁面選項,包括風險評估、濫用行為偵測、安全性報告和安全性動作。Advanced API Security 資料最多可能需要 10 分鐘才會顯示。
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 是您要將進階 API 安全性功能新增至符合資格的環境中,所需的 Apigee 預付制機構名稱。
- ENV_NAME 是您要啟用 Advanced API Security 外掛程式的 Apigee 環境名稱。
啟用完成後,請按一下「Advanced API Security」,查看可用於安全性資料的頁面選項,包括風險評估、濫用行為偵測、安全性報表和安全性動作。最多可能需要 10 分鐘,Advanced API Security 資料才會顯示在 UI 中,或透過 API 呼叫提供。
Advanced API Security 外掛程式啟用程序最多可能需要 15 分鐘才能完成。啟用後,環境的安全性資料會保留 14 個月。只要啟用外掛程式,您就可以在控制台的「進階 API 安全性」頁面中存取環境的歷來資料。
在啟用 Advanced API Security 外掛程式後,系統就會開始針對使用這項外掛程式收費。
停用 Advanced API Security 外掛程式
您可以使用 Google Cloud 主控台中的 Apigee UI 或 API,為中階或完整 Apigee 環境停用進階 API 安全性外掛程式,詳情請參閱下文。
Cloud 控制台中的 Apigee
如要在 Google Cloud 控制台中停用進階 API 安全性外掛程式,請按照下列步驟操作:
- 在控制台中開啟 Apigee 頁面。
- 選取使用預付費機構組織和您要管理的環境的專案。
- 依序選取「外掛程式」>「Advanced API Security」,開啟「Advanced API Security 外掛程式」頁面。
- 在「管理進階 API 安全性外掛程式」窗格中,選取要停用外掛程式的環境 (可多選) 旁邊的核取方塊。
- 按一下「停用所選項目」。
- 停用完成後,每個環境的「狀態」會顯示 「已停用」。
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 付費即用組織的名稱,您可以在該組織中,在符合條件的環境中停用進階 API 安全性。
- ENV_NAME 是您要停用 Advanced API Security 外掛程式的 Apigee 環境名稱。
查看環境中的 Advanced API Security 外掛程式狀態
您可以使用 Google Cloud 主控台中的 Apigee UI 或 API,查看中階或完整 Apigee 環境的進階 API 安全性外掛程式的狀態,如以下各節所述。
Google Cloud 控制台中的 Apigee
如要使用控制台查看環境中進階 API 安全性外掛程式的狀態,請按照下列步驟操作: Google Cloud
- 在控制台中開啟 Apigee 頁面。
- 選取使用預付費機構組織和您要管理的環境的專案。
- 依序選取「外掛程式」>「Advanced API Security」,開啟「Advanced API Security 外掛程式」頁面。
- 在「管理進階 API 安全性外掛程式」窗格中,會顯示環境清單。
- 您可以在狀態欄中查看各個中級或進階環境中的外掛程式是否已啟用或停用。基本環境不會顯示任何狀態。
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 安全性資料
為環境啟用進階 API 安全性外掛程式後,該環境的安全性資料會保留 14 個月。您可以透過控制台的「安全性報告」頁面,存取環境先前產生的安全性報告,但無法建立新的報告。
如果您在環境中停用進階 API 安全性外掛程式,系統會在 30 天後刪除該環境的安全性資料。如果您在停用後的 30 天內,在相同環境中重新啟用外掛程式,就能在 14 個月的保留期間重新存取該環境的安全性資料。如果在 30 天後重新啟用環境的外掛程式,系統就不會還原任何資料。
如果您想保留任何環境的安全性報表,且保留期限超過 14 個月,建議您匯出資料並儲存在其他位置。您可能也想在停用外掛程式前,或在停用後的 30 天內,匯出進階 API 安全性資料。您可以使用控制台「安全性報表」頁面中的「匯出」按鈕匯出安全性報表,也可以使用安全性報表 API 下載報表。