進階 API 作業總覽

本頁內容適用於 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 說明文件。

Apigee 的 Advanced API Operations (AAPI Ops) 提供相關工具，協助您確保 API 正常運作。AAPI Ops 會自動偵測 API 流量中的異常模式 (稱為「異常」)，例如延遲或錯誤率突然飆升。異常狀況可能代表 API 成效有問題。當 AAPI Ops 偵測到異常情況時，您可以在「Anomaly Events」資訊主頁中查看詳細資料，並採取適當行動來還原正常的 API 行為。

重要事項： 「異常偵測」是指進階 API 作業異常偵測功能，這項功能適用於傳統 Apigee 使用者介面。這項功能與 Cloud 控制台中的 Apigee UI 的「Operations Anomalies」(作業異常) 功能類似。目前兩者皆可使用。 如要瞭解作業異常狀況功能，請參閱作業異常狀況總覽。�

注意：AAPI Ops 是付費外掛程式，可擴充 Apigee API Monitoring 的功能。您可以在任何試用機構中試用 AAPI Ops。如要瞭解詳情，請與 Apigee 聯絡。

AAPI Ops 可讓您：

• 偵測異常狀況：AAPI Ops 會在「Anomaly Events」資訊主頁中，回報異常的 API 事件 (異常狀況)。
• 調查異常情況：當 AAPI Ops 偵測到異常情況時，您可以深入瞭解事件發生地點和時間，以及觸發原因，以便快速解決問題。
• 建立異常狀況快訊，並設定通知，讓 Apigee 在發生事件時傳送訊息給您。您可以透過多個管道接收通知，包括電子郵件、Slack、PagerDuty 或 Webhook。

如要進一步瞭解異常狀況，請參閱「 關於異常偵測」。

AAPI Ops 的必要角色

如要使用 AAPI Ops，您必須獲派下列角色：

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

詳情請參閱「Apigee 角色」。

在機構中啟用 AAPI Ops

如要使用 AAPI Ops，必須在貴機構中啟用這項功能。請先取得 OAuth 2.0 存取憑證，然後，您可以使用傳遞存取權杖的 API 呼叫，啟用 AAPI Ops。

查看目前的外掛程式設定

啟用 AAPI Ops 前，請先發出下列 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 Ops。如果沒有，請按照下節說明啟用這項功能。

啟用 AAPI Ops

如要在機構中啟用 AAPI Ops 並使用預設設定，請發出如下所示的 POST 要求。

注意：這個 API 呼叫會覆寫目前的外掛程式設定。您必須在上述要求中加入所有外掛程式的目前設定，以免遭到覆寫。

注意：下列 API 呼叫會啟動長時間執行的作業，可能需要一段時間才能完成。

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 Ops

如果基於某些原因，您需要在機構中停用 AAPI Ops，可以發出 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": {
      "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」。