Apigee API Analytics アドオンを管理する

このページの内容は Apigee に適用されます。Apigee ハイブリッドには適用されません。

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

Apigee Analytics は、API プロキシを介して送受信される多くの情報を収集して計算します。このデータは、Apigee UI のグラフやチャートを使用して可視化できます。また、Apigee API を使用して元データをダウンロードし、オフラインで分析することもできます。Apigee API Analytics で収集および分析できるデータの種類の詳細については、Apigee Analytics の概要をご覧ください。

Apigee 従量課金制のお客様の場合は、Apigee API Analytics を有料アドオンとして利用できます。このトピックでは、対象の従量課金制環境で Apigee API Analytics アドオンを有効にして管理する方法について説明します。Apigee 環境でアドオンを有効にした後、Apigee API Analytics ダッシュボードを使用する方法については、Analytics ダッシュボードの使用をご覧ください。

対象

Apigee API Analytics は、Apigee の実装内で Apigee 環境ごとに管理される有料のアドオン機能として利用できます。アドオンは、Apigee の中間環境または包括的な環境で有効にできます。基本環境では、Apigee API Analytics を有効にして使用できません。Apigee 環境の機能の詳細については、環境タイプの比較をご覧ください。

必要なロールと権限

Apigee API Analytics アドオンの管理に必要な権限を取得するには、プロジェクトの Apigee 環境管理者 IAM ロール（apigee.environment.admin）の付与を管理者に依頼してください。ロールの付与については、プロジェクト、フォルダ、組織へのアクセスを管理するをご覧ください。

この事前定義ロールには、Apigee API Analytics アドオンの管理に必要な権限が含まれています。必要とされる正確な権限については、「必要な権限」セクションを開いてご確認ください。

必要な権限

Apigee API Analytics アドオンを管理するには、次の権限が必要です。

  • apigee.addonsconfig.get
  • apigee.addonsconfig.update

カスタムロールや他の事前定義ロールを使用して、これらの権限を取得することもできます。

Apigee API Analytics アドオンを有効にする

以下のセクションで説明するように、Apigee API Analytics アドオンは、Google Cloud コンソールの Apigee UI または API を使用して、Apigee の中間環境または包括的な環境で有効にすることができます。

Google Cloud コンソールの Apigee

Google Cloud コンソールで Apigee API Analytics アドオンを有効にするには:

  1. コンソールで [Apigee] ページを開きます。

    [Apigee] に移動

  2. 従量課金制の組織と環境を管理するプロジェクトを選択します。
  3. [アドオン] > [分析] を選択して、[Analytics add-on] ページを開きます。
  4. [Manage Apigee API Analytics add-on] ペインで、アドオンを有効にする環境のチェックボックスをオンにします（複数も可）。
  5. [選択項目を有効化] をクリックします。
  6. 選択した環境の有効化が完了すると、環境の [ステータス] に （有効）と表示されます。
  7. Apigee API Analytics データを表示するには、[分析] > [API 指標] を選択して、分析データを表示します。 分析データが表示されるまで 10 分ほどかかることがあります。

Apigee API

Apigee API を使用して Apigee API Analytics アドオンを有効にするには、次のコマンドを入力します。

curl -X POST \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig:setAddonEnablement \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json" \
      -d '{"analyticsEnabled":true}'

ここで

  • ORG_NAME は、Analytics を対象の環境に追加する Apigee 従量課金制組織の名前です。
  • ENV_NAME は、Apigee API Analytics アドオンを有効にする Apigee 環境の名前です。

有効化が完了したら、[分析] > [API 指標] を選択して Apigee API Analytics データを表示します。分析データが UI に表示されるか、API 呼び出しを介して使用できるようになるまでに 10 分ほどかかることがあります。

Apigee API Analytics アドオンの有効化処理には 15 分ほどかかる場合があります。有効にすると、環境の分析データは 14 か月間保持されます。アドオンが有効になっている限り、環境の履歴データにはコンソールの [API 指標] ページからアクセスできます。

Apigee API Analytics アドオンの使用に対する課金は、アドオンの有効化が開始されると始まります。

Apigee API Analytics アドオンを無効にする

以下のセクションで説明するように、Apigee の中間環境または包括的な環境の Apigee API Analytics アドオンを無効にするには、Google Cloud コンソールの Apigee UI を使用するか、API を使用します。

環境で Advanced API Security アドオンが有効になっている場合、Apigee API Analytics アドオンを無効にする前に Advanced API Security アドオンを無効にしておく必要があります。Advanced API Security アドオンが無効になっていない場合、環境で Apigee API Analytics を無効にするリクエストはすべて失敗します。 ご使用の環境で Advanced API Security アドオンが有効になっている場合、そのアドオンは [Manage Apigee API Analytics add-on] ペインの [Other enabled add-ons] 列に表示されます。

アドオンを無効にするには、Advanced API Security アドオンを無効にするをご覧ください。

Cloud コンソールの Apigee

Google Cloud コンソールで Apigee API Analytics アドオンを無効にするには:

  1. コンソールで [Apigee] ページを開きます。

    [Apigee] に移動

  2. 従量課金制の組織と環境を管理するプロジェクトを選択します。
  3. [アドオン] > [分析] を選択して、[Analytics add-on] ページを開きます。
  4. [Manage Apigee API Analytics add-on] ペインで、アドオンを有効にする環境のチェックボックスをオフにします（複数も可）。
  5. [選択項目を無効化] をクリックします。
  6. 無効化が完了すると、各環境の [ステータス] に （無効）と表示されます。

Apigee API

Apigee API を使用して Apigee API Analytics アドオンを無効にするには、次のコマンドを入力します。

curl -X POST \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig:setAddonEnablement \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json" \
      -d '{"analyticsEnabled":false}'

ここで

  • ORG_NAME は、Analytics を対象の環境に追加する Apigee 従量課金制組織の名前です。
  • ENV_NAME は、Apigee API Analytics アドオンを有効にする Apigee 環境の名前です。

環境の Apigee API Analytics アドオンのステータスを表示する

以下のセクションで説明するように、Apigee の中間環境または包括的な環境の Apigee API Analytics アドオンのステータスを確認するには、Google Cloud コンソールの Apigee UI または API を使用します。

Google Cloud コンソールの Apigee

Google Cloud コンソールを使用して環境の Apigee API アナリティクス アドオンのステータスを表示するには:

  1. コンソールで [Apigee] ページを開きます。

    [Apigee] に移動

  2. 従量課金制の組織と環境を管理するプロジェクトを選択します。
  3. [アドオン] > [分析] を選択して、[Analytics add-on] ページを開きます。
  4. [Manage Apigee API Analytics add-on] ペインに、環境のリストが表示されます。
  5. ステータス列では、各中間環境のアドオンが有効か無効かを確認できます。基本環境については、どちらのステータスも表示されません。

Apigee API

Apigee API を使用する環境で Apigee API Analytics アドオンのステータスを表示するには、次のコマンドを入力します。

curl -X GET \
  https://apigee.googleapis.com/v1/organizations/ORG_NAME/environments/ENV_NAME/addonsConfig \
      -H "Authorization: Bearer $token" \
      -H "Content-type: application/json"

ここで

  • ORG_NAME は Apigee 従量課金制組織の名前です。
  • ENV_NAME は Apigee 環境の名前です。

レスポンスでは、アドオンの現在のステータスを表す analyticsConfig オブジェクトが返されます。

Apigee API Analytics データを管理する

環境で Apigee API Analytics アドオンを有効にすると、環境の分析データは 14 か月間保持されます。アドオンが有効になっている限り、環境の過去の分析データにはコンソールの [API 指標] ページからアクセスできます。

環境で Apigee API Analytics アドオンを無効にすると、その環境の分析データは 30 日後に削除されます。アドオンを無効にしてから 30 日以内に同じ環境で再度有効にすると、14 か月間の保持期間を通じて環境の分析データに再びアクセスできるようになります。30 日を経過して環境でアドオンを再び有効にした場合、データは復元されません。

14 か月の保持期間を超えて環境の分析データを保持する場合は、データをエクスポートして別の場所に保存することをおすすめします。アナリティクス データは、Apigee API Analytics アドオンを無効にする前か、無効後 30 日以内にエクスポートすることもできます。詳細については、分析データのエクスポートをご覧ください。