高级 API 操作概览

本页面适用于 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 文档。

Apigee 的高级 API 操作 (AAPI Ops) 提供了可帮助您确保 API 按预期正常运行的工具。AAPI Ops 会自动检测 API 流量中的异常模式（称为“异常值”），例如延迟时间或错误率激增。异常值可能表示 API 性能出现问题。当 AAPI Ops 检测到异常值时，您可以在异常值事件信息中心内查看其详细信息，然后采取相应措施来恢复正常的 API 行为。

借助 AAPI Ops，您可以：

检测异常值：AAPI Ops 在异常值事件信息中心内报告异常 API 事件（异常值）。
调查异常值：当 AAPI Ops 检测到异常值时，您可以深入探究突发事件发生的位置和时间，以及触发突发事件的情况，从而能够迅速解决问题。
创建异常值提醒并设置通知，让 Apigee 在突发事件发生时向您发送消息。您可以通过多种渠道接收通知，包括电子邮件、Slack、PagerDuty 或网络钩子。

如需详细了解异常值，请参阅异常值检测简介。

AAPI Ops 所需角色

要使用 AAPI Ops，您需要具有以下角色：

roles/apigee.readOnlyAdmin
roles/logging.viewer
roles/monitoring.viewer

如需了解详情，请参阅 Apigee 角色。

在组织中启用 AAPI 操作

如需使用 AAPI 操作，您必须在组织中启用它。在此之前，请先获取 OAuth 2.0 访问令牌。然后，您可以使用 API 调用来传递访问令牌以启用 AAPI 操作。

查看当前插件配置

在启用 AAPI 操作之前，请通过进行以下 API 调用来检查是否已启用：

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

其中 YOUR_ORG 是您的组织的名称，$TOKEN 是 OAuth 访问令牌的环境变量。此操作会返回有关您的组织的基本信息，其中包括 Apigee 插件的部分（以下面一行开头）：

"addonsConfig": {

检查此部分是否包含以 "advancedApiOpsConfig" 开头的条目，如以下示例所示：

"advancedApiOpsConfig": {
          "enabled": "true"
      }

如果存在此条目，则表示组织中已启用 AAPI 操作。否则，您需要按照下文所述启用它。

启用 AAPI 操作

如需使用默认配置在组织中启用 AAPI 操作，请发出 POST 请求，如下所示。

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

其中，<Current add-ons configuration> 是当前插件配置。您可以在调用以查看当前插件配置的响应中找到当前插件配置。例如，如果当前插件配置是

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

用于启用 AAPI Ops 的命令是

curl "https://apigee.googleapis.com/v1/organizations/YOUR_ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "advancedApiOpsConfig": {
          "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"
  }
}

在组织中停用 AAPI 操作

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

curl "https://apigee.googleapis.com/v1/organizations/$ORG:setAddons" \
  -X POST \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-type: application/json" \
  -d '{
    "addonsConfig": {
      "advancedApiOpsConfig`": {
          "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。