NerdGraphチュートリアル。APIキーの管理

このドキュメントには、 NerdGraph をNew RelicAPI 使用して、ライセンスキー、 キー、 などの キーをプログラムで管理する方法に関するチュートリアルが含まれています。browserユーザーキーキーに関する一般的な情報については、 APIキーを参照してください。

機能説明の概要

API キー UIを使用してキーを作成および管理できます。または、 NerdGraphのApiAccessフィールドを使用して、次のタイプのキーをプログラムで作成および管理できます。

• ユーザーキー, NerdGraphを使用するために必要です。

• などのデータインジェストキー。

  • ライセンスキー: ブラウザ監視データとモバイル監視データを除くほとんどのデータを New Relic に取り込むために必要です
  • ブラウザキー: ブラウザモニタリングデータの取り込みに必要です。

この機能の一般的な使用例としては、セキュリティのためにキーを回転させる機能があります。なお、このNerdGraphの機能を使って、あるアカウントで最初に作成されたライセンス・キーやブラウザ・キーを削除することはできないので、オリジナルのキーを削除することはできません。追加ライセンス・キーの作成と、作成したライセンス・キーの管理のみ可能です。

この機能についての注意事項

• すべてのミューテーションは、複数のキーを引数として受け取ることができ、変更の成功とエラーに関する詳細を返します。詳細は以下の例を参照してください。

• すべてのミューテーション (作成、更新、および削除) は、監査目的で照会できるNrAuditEventになります。詳細については、「 監査イベント」を参照してください。

• ライセンスキーについて

  • ライセンスキーはNerdGraphによってingest keysに分類されます。 これは、主な用途がデータの取り込みを可能にすることだからです。
  • ライセンスキーの種類ごとに最大1,000個のキーを作成することができ、キーのローテーションが可能です。
  • オリジナルのライセンスキーを管理・削除することはできず、追加のライセンスキーを作成したり、作成したキーを管理することのみが可能です。

使用例の前に

これらのサンプルクエリを使用する前に注意すべきことがあります。

• 以下の例では、ライセンスキー（別名インジェストキー）を使用していますが、インジェストキー固有のフィールドをユーザーキー固有のフィールドに置き換えて、同様の方法で ユーザーキー を照会することができます。
• データ構造を理解するには、 GraphiQL explorer を使って、クエリを試してみることをお勧めします。
• また、 UIを使ってユーザーキーの作成、閲覧、削除を行うことができます。

キーの作成

複数のアカウントとキータイプに対して、1回のミューテーションで複数のキー（ユーザーキーまたはライセンスキー）を作成すること。なお、ミューテーションでは、正常に作成されたキーだけでなく、キーの作成時に発生したエラーも返すことができます。

キーの作成例

mutation {
  apiAccessCreateKeys(
    keys: {
      ingest: {
        accountId: YOUR_ACCOUNT_ID
        ingestType: BROWSER
        name: "Browser Key"
        notes: "A note."
      }
    }
  ) {
    createdKeys {
      id
      key
      name
      notes
      type
      ... on ApiAccessIngestKey {
        ingestType
      }
    }
    errors {
      message
      type
      ... on ApiAccessIngestKeyError {
        accountId
        errorType
        ingestType
      }
    }
  }
}

結果はあなたのデータによって異なります。 GraphiQL explorer を使って、ミューテーションやクエリーを試してみてください。

このクエリを使って、 ユーザーキー を作成する例を示します。

mutation {
  apiAccessCreateKeys(
    keys: { user: { accountId: YOUR_ACCOUNT_ID, userId: YOUR_USER_ID } }
  ) {
    createdKeys {
      id
      key
      name
      notes
      type
      ... on ApiAccessIngestKey {
        ingestType
      }
    }
    errors {
      message
      type
      ... on ApiAccessIngestKeyError {
        accountId
        errorType
        ingestType
      }
    }
  }
}

キーの更新

アップデート・ミューテーションでは、キー文字列ではなく、キーIDを使ってキーを識別します。

mutation {
  apiAccessUpdateKeys(
    keys: {
      ingest: { keyId: KEY_ID, name: "Updated name", notes: "A new note!" }
    }
  ) {
    updatedKeys {
      id
      key
      type
      name
      notes
    }
    errors {
      message
    }
  }
}

結果はあなたのデータによって異なります。 GraphiQL explorer を使って、ミューテーションやクエリーを試してみてください。

削除キー

削除変異では、キーの識別にキー文字列ではなくキーIDを使用します。削除されたキーは、New Relic システムへのアクセスが許可されなくなり、API アクセス GraphQL API への問い合わせで返されなくなります。

mutation {
  apiAccessDeleteKeys(keys: { ingestKeyIds: INGEST_KEY_ID }) {
    deletedKeys {
      id
    }
    errors {
      message
    }
  }
}

結果はあなたのデータによって異なります。 GraphiQL explorer を使って、ミューテーションやクエリーを試してみてください。

検索キー

インジェストキーやユーザーキーにアクセスするには、アクターにスコープされた単一のキーまたはすべてのキーを照会します。単一のキーを照会する場合は、キーの ID とタイプ（INGEST または USER）を指定する必要があります。複数のキーを照会する場合は、キー検索を使用します。キー検索では、必須のタイプリストとオプションのスコープを使用して結果をフィルタリングします。他のユーザーに属するユーザーキーは、結果が難読化されます。

シングルキーの例のクエリです。

query {
  actor {
    apiAccess {
      key(id: "INGEST_KEY_ID", keyType: INGEST) {
        key
        name
        type
        ... on ApiAccessIngestKey {
          ingestType
        }
      }
    }
  }
}

主要な検索例クエリ。

query {
  actor {
    apiAccess {
      keySearch(query: { types: INGEST, scope: { ingestTypes: BROWSER } }) {
        keys {
          name
          key
          type
          ... on ApiAccessIngestKey {
            ingestType
          }
        }
      }
    }
  }
}

結果はあなたのデータによって異なります。 GraphiQL explorer を使って、ミューテーションやクエリーを試してみてください。