進階 API 作業總覽

本頁適用於 Apigee 和 Apigee Hybrid。

查看 Apigee Edge 說明文件。

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

AAPI Ops 可讓您：

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

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

AAPI 作業所需的角色

如要使用 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 作業。如果沒有，請按照下文所述啟用這項功能。

啟用 AAPI 作業

如要在組織中啟用 AAPI Ops 並套用預設設定，請發出如下所示的 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 Ops

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