本頁面由 Cloud Translation API 翻譯而成。

開始使用

本頁適用於 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 說明文件。

本頁面說明如何開始使用訂閱和預付費用機構的進階 API 安全性。

必要角色和權限

以下各節將說明使用進階 API 安全防護功能執行工作時，所需的角色和權限。

安全性報告的必要角色

下表列出執行安全性報表相關工作所需的角色。

安全性報告工作	必要角色
啟用或停用進階 API 安全性	Apigee 機構管理員 (`roles/apigee.admin`)
可製作報表	Apigee 機構管理員 (`roles/apigee.admin`) Apigee 安全性管理員 (`roles/apigee.securityAdmin`)
查看報表	Apigee 安全檢視器 (`roles/apigee.securityViewer`) Apigee 安全管理員 (`roles/apigee.securityAdmin`)

風險評估的必要角色

下表列出執行風險評估相關工作所需的角色。

風險評估工作	必要角色
建立、更新或刪除自訂安全性設定檔	Apigee 安全性管理員 (`roles/apigee.securityAdmin`) Apigee 機構管理員 (`roles/apigee.admin`)
附加或解除安全性設定檔	Apigee 安全性管理員 (`roles/apigee.securityAdmin`) Apigee 機構管理員 (`roles/apigee.admin`)
查看安全性分數	Apigee 安全性管理員 (`roles/apigee.securityAdmin`) Apigee 安全性檢視器 (`roles/apigee.securityViewer`) Apigee 機構管理員 (`roles/apigee.admin`)
列出所有安全性設定檔或取得設定檔	Apigee 安全性管理員 (`roles/apigee.securityAdmin`) Apigee 安全性檢視器 (`roles/apigee.securityViewer`) Apigee 機構管理員 (`roles/apigee.admin`)
建立、更新或刪除安全監控條件	Apigee 安全性管理員 (`roles/apigee.securityAdmin`) Apigee 機構管理員 (`roles/apigee.admin`)
列出及查看安全監控條件	Apigee 安全性管理員 (`roles/apigee.securityAdmin`) Apigee 安全性檢視器 (`roles/apigee.securityViewer`) Apigee 機構管理員 (`roles/apigee.admin`)
列出及查看安全監控條件指標	監控管理員 (`roles/monitoring.admin`) 監控編輯器 (`roles/monitoring.editor`)
建立、更新或刪除監控快訊	請參閱「必要角色 (安全性快訊)」
查看監控快訊	請參閱「以指標為基礎的快訊政策事件：開始前須知事項」

偵測濫用行為所需的角色和權限

下表列出執行濫用行為偵測相關工作所需的角色和權限。

濫用行為偵測工作	必要角色和權限
在濫用偵測 UI 中查看事件	Apigee 安全性管理員 (`roles/apigee.securityAdmin`) Apigee 安全性檢視器 (`roles/apigee.securityViewer`) Apigee 機構管理員 (`roles/apigee.admin`)
查看事件生成式 AI 深入分析資訊	`cloudaicompanion.instances.generateText` 權限
為組織選擇啟用或停用用於濫用行為偵測的機器學習模型	`apigee.securitySettings.update` 權限 Apigee 安全性管理員 (`roles/apigee.securityAdmin`) Apigee 機構管理員 (`roles/apigee.admin`)

安全性動作的必要角色

下表列出執行安全性動作相關工作所需的角色。

安全性動作工作	必要角色
建立安全性動作	Apigee 安全性管理員 (`roles/apigee.securityAdmin`) Apigee 機構管理員 (`roles/apigee.admin`)
更新安全性動作設定	Apigee 安全性管理員 (`roles/apigee.securityAdmin`) Apigee 機構管理員 (`roles/apigee.admin`)
查看或列出安全性動作	Apigee 安全性管理員 (`roles/apigee.securityAdmin`) Apigee 安全性檢視者 (`roles/apigee.securityViewer`) Apigee 機構管理員 (`roles/apigee.admin`)
查看執行狀態	Apigee 安全性管理員 (`roles/apigee.securityAdmin`) Apigee 安全性檢視者 (`roles/apigee.securityViewer`) Apigee 機構管理員 (`roles/apigee.admin`)

管理訂閱機構的進階 API 安全性

如要以訂閱方案客戶身分使用 Advanced API Security，Advanced API Security 必須是您的訂閱方案授權的一部分。請參閱 Apigee 授權。如要將 Advanced API Security 新增至授權，請與 Apigee 銷售人員聯絡。

當進階 API 安全性成為您的授權權限的一部分後，請在機構中啟用這項功能：

取得 Apigee 外掛程式設定
為訂閱機構啟用 Advanced API Security

如果不確定自己是否使用訂閱或即付即用的 Apigee 機構，請與 Apigee 機構管理員聯絡。

取得 Apigee 外掛程式設定

如要為訂閱組織啟用進階 API 安全性，您必須先使用下列 API 呼叫取得目前的 Apigee 外掛程式設定。這也會告訴您是否已啟用 Advanced API Security。

curl "https://apigee.googleapis.com/v1/organizations/ORG" \
  -X GET \
  -H "Content-type: application/json" \
  -H "Authorization: Bearer $TOKEN"

其中

ORG 是貴機構的名稱。
$TOKEN 是 OAuth 存取權杖的環境變數。

這個呼叫會傳回機構的基本資訊，包括 Apigee 外掛程式設定的部分，該部分以以下行開頭：

"addonsConfig": {

請檢查這個部分是否包含下列項目：

"apiSecurityConfig": {
          "enabled": true
      }

如果是，表示貴機構已啟用進階 API 安全性。否則，您必須啟用這項功能，請參閱下文說明。

為訂閱方案機構啟用進階 API 安全性

如要在訂閱組織中啟用預設設定的進階 API 安全性，請發出如下所示的 POST 要求。

curl "https://apigee.googleapis.com/v1/organizations/ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "apiSecurityConfig": {
          "enabled": true
      }
      <Other entries of your current add-ons configuration>
    }
  }'

其中

ORG 是貴機構的名稱。
$TOKEN 是 OAuth 存取權杖的環境變數。
<Other entries of your current add-ons configuration> 包含您目前 Apigee 外掛程式設定的任何其他項目。

舉例來說，如果目前的外掛程式設定為

"addonsConfig": {
  "integrationConfig": {
      "enabled":true
  },
  "monetizationConfig": {
      "enabled":true
  }
},

啟用進階 API 安全性的指令如下：

curl "https://apigee.googleapis.com/v1/organizations/ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "apiSecurityConfig": {
          "enabled": true
      },
      "integrationConfig": {
          "enabled": true
      },
      "monetizationConfig": {
          "enabled": true
      }
    }
  }'

傳送要求後，您會看到類似以下的回應：

{
  "name": "organizations/apigee-docs-d/operations/0718a945-76e0-4393-a456-f9929603b32c",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/apigee-docs-d",
    "state": "IN_PROGRESS"
  }
}

為訂閱機構停用 Advanced API Security

如果您基於某些原因需要在訂閱組織中停用進階 API 安全性，可以發出 POST 要求，並在要求主體中傳遞外掛程式設定，如下所示。

curl "https://apigee.googleapis.com/v1/organizations/$ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "apiSecurityConfig": {
          "enabled": false
      }
     <Include current add-ons configuration>
    }
  }'

以下是顯示作業進行中的回應範例：

{
  "name": "organizations/$ORG/operations/06274ffb-8940-41da-836d-781cba190437",
  "metadata": {
    "@type": "type.googleapis.com/google.cloud.apigee.v1.OperationMetadata",
    "operationType": "UPDATE",
    "targetResourceName": "organizations/$ORG",
    "state": "IN_PROGRESS"
  }
}

詳情請參閱「設定機構外掛程式 API」一文。

管理即付即用機構的進階 API 安全性

如果您是Pay-as-you-go客戶，可以啟用 Advanced API Security 做為付費外掛程式。如要進一步瞭解如何為中級或全面的 Apigee 環境啟用 Advanced API Security 外掛程式，請參閱「管理 Advanced API Security 外掛程式」。

如果不確定自己是否使用訂閱或即付即用的 Apigee 機構，請與 Apigee 機構管理員聯絡。

管理評估機構的進階 API 安全性

Apigee 試用 (評估) 機構會自動納入進階 API 安全性外掛程式，但您必須啟用這項功能。

如要啟用這項功能，請按照「為訂閱組織啟用進階 API 安全性」中的操作說明進行。

如果需要停用，請按照「為訂閱機構停用 Advanced API Security」中的操作說明進行。

後續步驟

啟用進階 API 安全性後，請參閱下列各節：