Tutoriel NerdGraph : Gérer APIclé

Ce document contient des tutoriels sur la New Relic façon d'utiliser NerdGraph pour gérer par programmation certaines clés API: la clé de licence, la clé de navigateur et clé d'utilisateurle. Pour des informations générales sur nos clés, consultez clé API.

Aperçu de la description des fonctionnalités

Vous pouvez utiliser l'clé API UI pour créer et gérer des clés. Vous pouvez également utiliser le champ ApiAccess de NerdGraph pour créer et gérer par programmation les types de clés suivants :

• Clés utilisateur, requises pour utiliser NerdGraph

• Clés d’ingestion de données, notamment :

  • Le clé de licence: requis pour l'ingestion de la plupart des données vers New Relic, à l'exception des données monitoring de navigateursetmonitoring d'applications mobiles
  • clé du navigateur: nécessaire pour l'ingestion des données monitoring des navigateurs

Un cas d’utilisation courant de cette fonctionnalité est la possibilité de faire tourner les clés à des fins de sécurité. Notez que vous ne pouvez pas utiliser cette fonctionnalité NerdGraph pour supprimer la clé de licence ou la clé de navigateur qui a été créée à l'origine avec un compte ; ces clés d'origine ne peuvent pas être supprimées. Vous ne pouvez créer que des clés de licence supplémentaires et gérer celles que vous avez créées.

Remarques sur cette fonctionnalité :

• Toutes les mutations peuvent accepter plusieurs clés comme arguments et renverront des détails sur les modifications réussies et les erreurs. Voir les exemples ci-dessous pour plus de détails.

• Toutes les mutations (création, mise à jour et suppression) entraîneront un NrAuditEvent qui peut être interrogé à des fins d'audit. Pour plus de détails, voir Audit événement.

• Concernant les clés d'ingestion :

  • Les clés de licence et Browser sont classées par NerdGraph comme ingest keys. C’est parce que leur utilisation principale est de permettre l’ingestion de données.
  • Vous pouvez créer jusqu'à 1 000 clés de chaque type de clé d'ingestion, ce qui permet la rotation des clés.
  • Vous ne pouvez pas gérer ni supprimer les clés d'ingestion de compte d'origine, mais vous pouvez contacter le support New Relic pour les faire pivoter ; vous pouvez uniquement créer des clés d'ingestion ou d'utilisateur supplémentaires et gérer les clés que vous avez créées.

Avant d'utiliser des exemples

Éléments à noter avant d’utiliser ces exemples de requête :

• Pour comprendre la structure des données, nous vous recommandons d'expérimenter la requête à l'aide de l'explorateur GraphiQL.
• Vous pouvez également créer, afficher et supprimer des clés utilisateur à l'aide de l'UI.

Créer des clés

Pour créer plusieurs clés (clé utilisateur ou clé d'ingestion) dans une seule mutation, pour plusieurs comptes et types de clés. Notez que la mutation peut renvoyer des clés créées avec succès ainsi que toutes les erreurs rencontrées lors de la tentative de création de clés.

Exemple de création d'une clé :

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
      }
    }
  }
}

Les résultats varieront en fonction de vos données. Utilisez l'explorateur GraphiQL pour expérimenter les mutations et les requêtes.

Voici un exemple d'utilisation de cette requête pour créer une clé utilisateur:

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
      }
    }
  }
}

Mettre à jour les clés

La mutation de mise à jour prend l'ID de clé, et non la chaîne de clé, pour identifier les clés.

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

Les résultats varieront en fonction de vos données. Utilisez l'explorateur GraphiQL pour expérimenter les mutations et les requêtes.

Supprimer les touches

La mutation de suppression prend l'ID de clé, et non la chaîne de clé, pour identifier les clés. Les clés supprimées ne donneront plus accès au système New Relic et ne seront plus renvoyées par requête à l'API d'accès GraphQL API.

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

Les résultats varieront en fonction de vos données. Utilisez l'explorateur GraphiQL pour expérimenter les mutations et les requêtes.

Clé de requête

Vous pouvez accéder aux clés d'ingestion et d'utilisateur en interrogeant une seule clé ou toutes les clés, limitées à actor. Si vous recherchez une clé unique, vous devez fournir l'ID et le type de clé (INGEST ou USER). L'interrogation de plusieurs clés s'effectue via une recherche de clé, qui utilise une liste de types obligatoires et une portée facultative pour filtrer les résultats. les clés utilisateur appartenant à d'autres utilisateurs seront masquées dans les résultats.

Exemple de requête à clé unique :

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

Exemple de requête de recherche de clé :

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

Les résultats varieront en fonction de vos données. Utilisez l'explorateur GraphiQL pour expérimenter les mutations et les requêtes.