API de recherche NRQL

Utilisez l'API NRQL Lookups pour créer et gérer une table de recherche .

Avant de commencer

L'NRQL Lookups API est une API REST qui vous permet de gérer des tables de recherche par programmation. Comme autre option, vous pouvez également gérer la table de recherche via notre UI.

Point de terminaison HTTP

URL de base

Utilisez l'URL de base applicable à votre compte New Relic dans votre appel d'API.

Point de terminaison des États-Unis :

https://nrql-lookup.service.newrelic.com

Point de terminaison de l’Union européenne (UE) :

https://nrql-lookup.service.eu.newrelic.com

point de terminaison

Méthode	point de terminaison	Description
`create`	`POST /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME`	Télécharger une nouvelle table.
`update`	`PUT /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME`	Remplacer une table existante.
`read`	`GET /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME`	Téléchargez un tableau qui a été précédemment téléchargé.
`delete`	`DELETE /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME`	Supprimer la table donnée.
`list`	`GET /v1/accounts/YOUR_ACCOUNT_ID`	Lister les tables précédemment mises à jour pour ce compte.

Les variables requises dans les points de terminaison d'API de NRQL Lookups ci-dessus sont définies ci-dessous.

Variable	Type	Description
`YOUR_ACCOUNT_ID`	`number`	Le compte auquel appartient la table
`TABLE_NAME`	`string`	Un nom pour la table stockée. Les noms de table doivent être conformes aux normes de type d'événement personnalisé: Longueur maximale : 255 Peut être une combinaison de caractères alphanumériques, de traits de soulignement et de deux points.

Variable

Type

Description

YOUR_ACCOUNT_ID

number

Le compte auquel appartient la table

TABLE_NAME

string

Un nom pour la table stockée. Les noms de table doivent être conformes aux normes de type d'événement personnalisé:

Longueur maximale : 255
Peut être une combinaison de caractères alphanumériques, de traits de soulignement et de deux points.

Authentification

Votre sert à authentifier votre demande auprès de l'API NRQL Lookups et doit être transmis en tant qu'en-tête HTTP.

En-tête	Valeurs prises en charge
`Api-Key`	Une New Relic .

Créer/Mettre à jour une table

Point de terminaison HTTP

Créer

POST /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME

Utilisé pour télécharger une nouvelle table. La table ne peut pas déjà exister. Si c'est le cas, cet appel entraînera une réponse 400 Bad Request .

Mise à jour

PUT /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME

Utilisé pour remplacer une table existante. Si la table n'existe pas, cet appel entraînera une réponse 404 Not Found .

Paramètre de requête de demande

Nom	Type	Défaut	Description
`includeTable`	`boolean`	`false`	Indique s'il faut inclure la valeur de la table dans la réponse.

En-têtes HTTP

Lors de la création de vos en-têtes HTTP, utilisez ces directives :

En-tête	Valeurs prises en charge
`Content-Type`	`multipart/form-data` `application/json`
`Accept`	`application/json`

Corps de la requête

Les données que vous envoyez dans le corps de votre requête peuvent être multipart/form-data ou application/json.

Champs pris en charge

Vous pouvez fournir les champs suivants dans vos requests de création et de mise à jour lors de l'envoi de contenu multipart/form-data :

Champ	Type de valeur	Requis	Description
`table`	Fichier CSV	Oui	Partie de données de formulaire en plusieurs parties qui contient le contenu CSV. Notre logique d’analyse CSV est décrite en détail ici.
`description`	`string`	Non	Deuxième partie de données de formulaire en plusieurs parties qui contient une description de la table.

Exemple de charge utile

--__X_BOUNDARY__
Content-Disposition: form-data; name="table"; filename="sample.csv"
Content-Type: text/csv

id,name,intvalue,floatvalue,boolvalue
'1,abc,27,2.7,true
'2,def,2622,26.22,false
'2a,"g,hi",1234,43.21,false
--__X_BOUNDARY__--
Content-Disposition: form-data; name="description"

A description of the table
--__X_BOUNDARY__--

Champs pris en charge

Vous pouvez fournir les champs suivants lors de votre création et de votre mise à jour lors de l'envoi de contenu application/json :

Champ

Type de valeur

Requis

Description

table

JSON

Oui

`headers`	Un éventail de valeurs `string` représentant les noms de colonnes de la table
`rows`	Un éventail d'éventail, représentant les valeurs du tableau. Toutes les valeurs doivent être des valeurs `string`, `number` ou `boolean` . (Les objets JSON complexes ne sont pas autorisés.)

description

string

Non

Une description détaillée du tableau

Exemple de charge utile

{
  "table": {
    "headers": ["id", "name", "intvalue", "floatvalue", "boolvalue"],
    "rows": [
      ["1", "abc", 27, 2.7, true],
      ["2", "def", 2622, 26.22, false],
      ["2a", "d,ef", 1234, 43.21, false]
    ]
  },
  "description": "This is a description."
}

Corps de la réponse

Si la demande réussit, la charge utile JSON de la réponse peut inclure les champs suivants :

Champ

Type de valeur

Description

accountId

number

Le compte auquel appartient la table. Cela correspondra à la valeur du compte dans le chemin.

name

string

Un nom pour la table stockée. Cela correspondra à la valeur du nom dans le chemin.

description

string

Une description détaillée du tableau

guid

string

Le GUID attribué à la table lors de sa création.

size

number

Taille du tableau sous forme de chaîne CSV.

rows

number

Le nombre de lignes dans le tableau (à l'exclusion de la ligne d'en-tête)

updatedBy

string

Le nom d'utilisateur/adresse e-mail du dernier utilisateur qui a créé ou mis à jour ce tableau.

updatedAt

string

L'horodatage de la création ou de la dernière mise à jour de la table. Cela reflétera le dernier horodatage mis à jour de l'objet S3. La valeur sera une chaîne de date et d'heure standard ISO 8601 (ex. 2023-02-13T19:49:28.023Z)

table

JSON objet littéral

`headers`	Un éventail de valeurs `string` représentant les noms de colonnes de la table
`rows`	Un éventail d'éventail, représentant les valeurs du tableau.

Exemple de charge utile JSON de réponse

{
  "accountId": YOUR_ACCOUNT_ID,
  "name": "sample",
  "guid": "eac37270-7c02-4ca9-b178-8be5748b5b09",
  "size": 120
  "rows": 3
  "updatedBy": "jondoe@example.com"
  "updatedAt": "2023-02-13T19:49:28.023Z",
  "table": {
    "headers": [
      "id", "name", "description", "intvalue", "floatvalue", "boolvalue"
    ],
    "rows": [
      [1, "abc", 27, 2.7, true],
      [2, "def", 2622, 26.22, false],
      ["2a", "d,ef", 1234, 43.21, false]
    ]
  }
}

Exemples de demandes

Pour créer une nouvelle table de recherche, nous pouvons envoyer une requête POST au point de terminaison de création avec une charge utile JSON décrivant la table de recherche.

Voici un exemple de commande curl :

bash

$curl -X "POST" "https://nrql-lookup.service.newrelic.com/v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME" \
>      -H 'Content-Type: application/json' \
>      -H 'Api-Key: YOUR_USER_KEY'\
>      -d $'{
$  "table": {
$  "headers": ["id", "name", "intvalue", "floatvalue", "boolvalue"],
$  "rows": [
$      ["1", "abc", 27, 2.7, true],
$      ["2", "def", 2622, 26.22, false]
$  ]
$  },
$  "description": "This is a description."
$  }'

Pour remplacer une table de recherche existante, nous pouvons envoyer une requête PUT au point de terminaison de mise à jour avec un corps de requête multipart/form-data contenant la nouvelle table.

bash

$curl -X "PUT" "https://nrql-lookup.service.newrelic.com/v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME" \
>   -H 'Api-Key: YOUR_USER_KEY'\
>   -H 'Content-Type: multipart/form-data; charset=utf-8; boundary=__X_PAW_BOUNDARY__' \
>   -F "table=id,name,description,intvalue,floatvalue,boolvalue
$      1,abc,desc1,27,2.7,true
$      2,def,desc2,2622,26.22,false
$      " \
>   -F "description=This is a description."

Lire un tableau

Point de terminaison HTTP

GET /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME

Utilisé pour télécharger un tableau qui a été précédemment téléchargé. Si la table n'existe pas, cet appel entraînera une réponse 404 Not Found . Ce point de terminaison n'a aucune charge utile de requête.

Paramètre de requête de demande

Nom	Type	Défaut	Description
`includeTable`	`boolean`	`false`	Indique s'il faut inclure la valeur de la table dans la réponse. Ignoré lorsque le type de contenu est `text/csv`.

En-têtes HTTP

Lors de la création de vos en-têtes HTTP, utilisez ces directives :

En-tête	Valeurs prises en charge
`Accept`	`application/json` `text/csv`

Corps de la réponse

Si la demande aboutit, la réponse peut être de type application/json ou text/csv.

Réponse de type `application/json`

La réponse sera la même que la charge utile de la réponse de création/mise à jour.

Réponse de type `text/csv`

La réponse contiendra le tableau au format CSV.

Exemples de demandes

Pour télécharger une table qui a été précédemment téléchargée, nous pouvons envoyer une requête GET au point de terminaison de mise à jour.

Voici un exemple de commande curl :

bash

$curl "https://nrql-lookup.service.newrelic.com/v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME" \
>     -H 'Accept: text/csv' \
>     -H 'Api-Key: YOUR_USER_KEY'

Voici un exemple de réponse text/csv :

id,name,intvalue,floatvalue,boolvalue
'1,abc,27,2.7,true
'2,def,2622,26.22,false
'2a,"g,hi",1234,43.21,false

Supprimer une table

Point de terminaison HTTP

DELETE /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME

Utilisé pour supprimer la table donnée. Si la table n'existe pas, cet appel entraînera une réponse 404 Not Found . Ce point de terminaison n'a aucune charge utile de requête.

Important

Les tables supprimées ne sont pas récupérables.

Paramètre de requête de demande

Nom	Type	Défaut	Description
`includeTable`	`boolean`	`false`	Indique s'il faut inclure la valeur de la table dans la réponse.

En-têtes HTTP

Lors de la création de vos en-têtes HTTP, utilisez ces directives :

En-tête	Valeurs prises en charge
`Accept`	`application/json`

Corps de la réponse

Si la demande réussit et que l'en-tête Accept est défini sur application/json, le corps de la réponse sera le même que la charge utile de la réponse de création/mise à jour.

Exemples de demandes

Pour supprimer une table qui a été précédemment téléchargée, nous pouvons envoyer une requête DELETE au point de terminaison de suppression.

Voici un exemple de commande curl :

bash

$curl -X "DELETE" "https://nrql-lookup.service.newrelic.com/v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME" \
>     -H 'Accept: application/json' \
>     -H 'Api-Key: YOUR_USER_KEY'\

Liste des tableaux

Point de terminaison HTTP

GET /v1/accounts/YOUR_ACCOUNT_ID

Répertorie les tables précédemment mises à jour pour ce compte. Ce point de terminaison n'a aucune charge utile de requête.

En-têtes HTTP

Lors de la création de vos en-têtes HTTP, utilisez ces directives :

En-tête	Valeurs prises en charge
`Accept`	`application/json`

Corps de la réponse

Si la requête aboutit, la réponse JSON sera constituée d'un éventail de résumés de tableaux. Chaque résumé de tableau peut inclure les champs ci-dessous.

Champ	Type de valeur	Description
`accountId`	`number`	Le compte auquel appartient la table. Cela correspondra à la valeur du compte dans le chemin.
`name`	`string`	Un nom pour la table stockée. Cela correspondra à la valeur du nom dans le chemin.
`description`	`string`	Une description plus détaillée du tableau
`guid`	`string`	Le GUID attribué à la table lors de sa création.
`size`	`number`	La taille du tableau sous forme de chaîne CSV.
`rows`	`number`	Le nombre de lignes dans le tableau (à l'exclusion de la ligne d'en-tête)
`updateBy`	`string`	Le nom d'utilisateur/adresse e-mail du dernier utilisateur qui a mis à jour ce tableau.
`updatedAt`	`string`	L'horodatage de la création ou de la dernière mise à jour de la table. Cela reflétera le dernier horodatage mis à jour de l'objet S3. La valeur sera une chaîne de date et d'heure standard ISO 8601 (ex. 2023-02-13T19:49:28.023Z)

Exemple de demande

Pour répertorier les tables d’un compte, nous pouvons envoyer une requête GET au point de terminaison de la liste.

Voici un exemple de commande curl :

bash

$curl "https://nrql-lookup.service.newrelic.com/v1/accounts/YOUR_ACCOUNT_ID" \
>     -H 'Accept: text/csv' \
>     -H 'Api-Key: YOUR_USER_KEY'

Voici un exemple de charge utile JSON de réponse :

[
  {
    "accountId": YOUR_ACCOUNT_ID,
    "name": "sample",
    "guid": "eac37270-7c02-4ca9-b178-8be5748b5b09",
    "size": 120
    "rows": 3
    "updatedBy": "jondoe@example.com"
    "updatedAt": "2023-02-13T19:49:28.023Z"
  },
  {
    "accountId": YOUR_ACCOUNT_ID,
    "name": "sample2",
    "guid": "eac37270-7c02-4ca9-b178-8be5748b5b09",
    "size": 4096
    "rows": 2000
    "updatedBy": "janedoe@example.com"
    "updatedAt": "2023-02-14T13:30:21.100Z"
  }
]

message d'erreur

Si une demande échoue, la charge utile de la réponse d’erreur sera au format ci-dessous.

{
  "code": HTTP_STATUS_CODE(same as status header),
  "message": ERROR_MESSAGE
}

Cette traduction automatique est fournie pour votre commodité.

Avant de commencer.css-21sua1{background:none;border:none;width:0;padding:0;}

Point de terminaison HTTP

URL de base

point de terminaison

Authentification

Créer/Mettre à jour une table

Point de terminaison HTTP

Créer

Mise à jour

Paramètre de requête de demande

En-têtes HTTP

Corps de la requête

Requête avec application/json

Corps de la réponse

Exemple de charge utile JSON de réponse

Exemples de demandes

Créer une nouvelle table

Mettre à jour une table existante

Lire un tableau

Point de terminaison HTTP

Paramètre de requête de demande

En-têtes HTTP

Corps de la réponse

Réponse de type application/json

Réponse de type text/csv

Exemples de demandes

Télécharger une table existante

Supprimer une table

Point de terminaison HTTP

Important

Paramètre de requête de demande

En-têtes HTTP

Corps de la réponse

Exemples de demandes

Supprimer une table existante

Liste des tableaux

Point de terminaison HTTP

En-têtes HTTP

Corps de la réponse

Exemple de demande

Liste des tables mises à jour pour un compte

message d'erreur

Avant de commencer

Réponse de type `application/json`

Réponse de type `text/csv`