Related pages:

このページでは、REST API キーの管理方法について説明します。

分析イベント REST API は、次の役割に対して 3 つの独立したエンドポイントを提供します。

  • スキーマ管理
  • イベントのパブリッシュ
  • クエリ イベント

API キーは、これらのパブリック REST API を使用するときに、呼び出し元が身元を証明するためのセキュアな認証メカニズムを提供します。

呼び出しサイトはインフラストラクチャ、部門、および地理的地域によって異なる可能性があるため、これらの資格情報は広く分散していて、制御が難しい場合があります。したがって、さまざまな呼び出しサイトからのイベントをパブリッシュまたは照会するために、キーと特定のキーに許可される操作をきめ細かく制御する必要があります。また、これらのキーが漏洩していることが判明した場合は、オンデマンドで取り消す必要がある場合があります。

このような理由から、分析イベント API のアクセスを管理するには、API キーを使用します。組織は、独自の内部ポリシーに基づいて複数の API キーを作成し、それらを管理および配布できます。たとえば、各部門または地理的地域に、配布および制御管理用の独自の API キーを割り当てることができます。API キーが漏洩した場合、そのキーを削除し、その他の不要な副作用のない新しいキーを作成できます。

API キーは、パブリック分析イベント REST API の呼び出しにのみ有効であり、このキーを使用して、その他の方法で AppDynamics コントローラやデータにアクセスすることはできません。詳細については、「分析イベント API」を参照してください。

権限

API キーは、分析イベント REST API にのみ使用されます。API キーを作成するとき、各 API キーの読み取り権限と書き込み権限を指定できます。

Manage API 権限を持つユーザは、次の操作を実行できます。

  • Add：API キーを作成します
  • Disable：そのキーを使用している呼び出しを一時的に無効にできますが、キーは削除できません
  • Enable：非アクティブ化されたキーを再度有効にします
  • Delete：キーを完全に削除します

削除または非アクティブ化されたキーが検出され、そのキーを使用するすべての操作が拒否されるまでに、最大 15 分かかることがあります。 

API キーを作成する場合、プラットフォームのさまざまなイベントタイプ（ログ、トランザクション、ブラウザ、およびモバイル）の権限を確認します。これらの権限を使用することで、特定の API キーごとに特定のイベントタイプへのアクセスを制限または許可できます。

次に例を示します。

パートナーがカスタムイベントのみを公開できるように API キーを作成する場合は、[Publish all Custom Events] を選択します。 

API キーを生成して、さまざまなユーザが Apache ログデータのみを照会できるようにするには、[ Log Permissions] でsource typeとして [apache] を選択します。 

API キーが作成された後では、権限は変更できません。

次のように、API キーの権限を付与できます。
Custom Analytics Events

    • スキーマの管理：分析イベントスキーマ管理 API を使用してスキーマを作成できます。
    • カスタムイベントの照会：（適切な権限を使用して）すべての分析イベントタイプを照会できます。
    • カスタムイベントのパブリッシュ：分析イベントパブリッシュ API を使用して、分析カスタムイベントをパブリッシュできます。

Transactions：すべてのトランザクションまたは特定のアプリケーションを照会します。

Logs：すべてのログまたは特定のソースタイプを照会します。

Browser Requests：すべてのブラウザ要求または特定のアプリケーションを照会します。 

Mobile Requests：すべてのモバイル要求または特定のアプリケーションを照会します。

Synthetic Requests Permissions：すべての合成要求データまたは特定のアプリケーションを照会します。

Connected Devices Permissions：接続されているデバイスのすべての要求データ、または特定のアプリケーションを照会します。

EUM をデプロイし、トランザクションおよびログ分析データに対してオンプレミス イベント サービスを使用し、EUM データに対して SaaS イベントサービスを使用している場合は、分析 API を使用してブラウザまたはモバイル要求データを照会できません。

API キーの作成

  1. [Analytics > Configuration] > [API Keys] の順にアクセスします。既存のキーを表示し、キーを管理するための操作にアクセスできます。 
  2. [+Add] をクリックして設定パネルを表示します。

  3. [Name] および [Description] を追加します。 

    必要な分析データ権限など、ユースケースに必要な権限をすべて選択し終わるまでは [Create] をクリックしないでください。一度キーを作成すると、権限を変更することはできません。編集できるのは、説明と、キーがアクティブか非アクティブかどうかのみです。

  4. 各権限セクションを展開して、このキーの権限を選択します。

  5. Create をクリックします。 

  6. キーをコピーして保存します。 

  7. キーをコピーしたことを示すチェックボックスをオンにして、[Done] をクリックします。 

    このダイアログを閉じた後は、キーを確認できません。