Advanced API Operations の概要

このページの内容は Apigee と Apigee ハイブリッドに該当します。

Apigee Edge のドキュメントを表示する。

Apigee の Advanced API Operations（AAPI Ops）は、API を意図したとおりに稼働させるために役立つツールです。AAPI Ops は、レイテンシやエラー率の急増など、API の普通ではないトラフィックパターン（異常）を自動的に検出します。異常は、API のパフォーマンスに問題がある兆候を示している可能性があります。AAPI Ops が異常を検知すると、Anomaly Events ダッシュボードで詳細を確認し、通常の API 動作を復元するために適切な対応を取ることができます。

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 を使用するには、組織で 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 リクエストを発行します。

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 を構成するをご覧ください。