使用入门

本页面适用于 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 文档。

本页面介绍了如何开始为订阅和随用随付组织使用 Advanced API Security。

所需的角色

以下部分介绍了使用 Advanced API Security 执行任务所需的角色。

安全报告所需的角色

下表展示了执行与安全报告相关的任务所需的角色。

安全报告任务	所需的角色
启用或停用 Advanced API Security	Apigee Organization Admin (roles/apigee.admin)
创建和查看报表	Apigee Organization Admin (roles/apigee.admin) Apigee Security Admin (roles/apigee.securityAdmin)
查看报告	Apigee Security Viewer (roles/apigee.securityViewer) Apigee Security Admin (roles/apigee.securityAdmin)

风险评估所需的角色

下表展示了执行与风险评估相关的任务所需的角色。

风险评估任务	所需的角色
创建、更新或删除自定义安全配置文件	Apigee Security Admin (roles/apigee.securityAdmin) Apigee Organization Admin (roles/apigee.admin)
附加或分离安全配置文件	Apigee Security Admin (roles/apigee.securityAdmin) Apigee Organization Admin (roles/apigee.admin)
查看安全得分	Apigee Security Admin (roles/apigee.securityAdmin) Apigee Security Viewer (roles/apigee.securityViewer) Apigee Organization Admin (roles/apigee.admin)
列出所有安全配置文件或获取一个配置文件	Apigee Security Admin (roles/apigee.securityAdmin) Apigee Security Viewer (roles/apigee.securityViewer) Apigee Organization Admin (roles/apigee.admin)

滥用行为检测所需的角色

下表显示了执行与滥用行为检测相关的任务所需的角色。

滥用行为检测任务	所需的角色
在滥用行为检测界面中查看突发事件	Apigee Security Admin (roles/apigee.securityAdmin) Apigee Security Viewer (roles/apigee.securityViewer) Apigee Organization Admin (roles/apigee.admin)

安全操作所需的角色

下表展示了执行与安全操作相关的任务所需的角色。

安全操作任务	所需的角色
创建安全操作	Apigee Security Admin (roles/apigee.securityAdmin) Apigee Organization Admin (roles/apigee.admin)
更新安全操作配置	Apigee Security Admin (roles/apigee.securityAdmin) Apigee Organization Admin (roles/apigee.admin)
查看或列出安全操作	Apigee Security Admin (roles/apigee.securityAdmin) Apigee Security Viewer (roles/apigee.securityViewer) Apigee Organization Admin (roles/apigee.admin)
检查强制执行状态	Apigee Security Admin (roles/apigee.securityAdmin) Apigee Security Viewer (roles/apigee.securityViewer) Apigee Organization Admin (roles/apigee.admin)

注意：如需进行以下部分中介绍的 API 调用，您需要获取 OAuth 2.0 访问令牌，其随调用一起传递。

管理订阅组织的 Advanced API Security

如需以订阅客户的身份使用 Advanced API Security，Advanced API Security 必须是订阅权益的一部分。请参阅 Apigee 权益。如需将 Advanced API Security 添加到您的权益，请与 Apigee 销售人员联系。

注意：Apigee 试用组织的试用期可能包含 Apigee Advanced API Security 试用。如需了解详情，请与 Apigee 销售人员联系。

在 Advanced API Security 成为您的权益后，请在组织中启用它：

• 获取 Apigee 插件配置
• 启用订阅组织的 Advanced API Security

如果您不确定您使用的是订阅还是随用随付 Apigee 组织，请与您的 Apigee 组织管理员联系。

获取 Apigee 插件配置

要为订阅组织启用 Advanced API Security，您首先需要使用以下 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
      }

如果包含，则表示组织中已启用 Advanced API Security。否则，您需要启用它，如下文所述。

启用订阅组织的 Advanced API Security

如需使用默认配置在订阅组织中启用 Advanced API Security，请发出 POST 请求，如下所示。

注意：此 API 调用会覆盖当前插件配置。您必须在下面显示的请求中包括所有插件的当前配置，以防止它们被覆盖。

注意：

• 如果您在启用 Advanced API Security 后创建新环境，则必须再次运行以下命令以为新环境启用 Advanced API Security。请注意，在再次运行该命令之前，不需要停用 Advanced API Security。
• 如果您只是从实例分离启用了 Advanced API Security 的环境，并在稍后重新附加环境，则无需再次运行以下命令。

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 插件配置的任何其他条目。

注意：以上 API 调用会启动一项长时间运行的操作，可能需要一段时间才能完成。

例如，如果当前插件配置是

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

则用于启用 Advanced API Security 的命令是

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 后，现有代理和目标的得分最多可能需要一天才能在环境中体现。

停用管理订阅组织的 Advanced API Security

如果由于某种原因，您需要在订阅组织中停用 Advanced API Security，则可以通过发出 POST 请求来在请求正文中传递插件配置，如下所示。

注意：您在请求正文中传递的插件配置将覆盖当前插件配置。在 Apigee 组织配置文件中查看当前插件配置，并务必将其包含在请求载荷中。

注意：以下 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": 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。

管理随用随付组织的 Advanced API Security

如果您是Pay-as-you-go客户，则可以将 Advanced API Security 作为付费插件启用。如需详细了解如何为中级或综合 Apigee 环境启用 Advanced API Security 插件，请参阅管理 Advanced API Security 插件。

如果您不确定您使用的是订阅还是随用随付 Apigee 组织，请与您的 Apigee 组织管理员联系。

后续步骤

启用 Advanced API Security 后，请查看以下部分：

• 安全报告
• 风险评估
• 滥用行为检测
• 安全操作