API de búsquedas NRQL

Utilice la API de búsquedas NRQL para crear y administrar tablas de búsquedas.

Antes de que empieces

La API de búsquedas NRQL es una API REST que le permite administrar la tabla de búsquedas mediante programación. Como otra opción también puedes gestionar la tabla de búsquedas a través de nuestra UI.

Extremo HTTP

URL base

Utilice la URL base que corresponda a su cuenta New Relic en su API de llamada.

Extremo de Estados Unidos (EE.UU.):

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

Extremo de la Unión Europea (UE):

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

Extremo

Método	Extremo	Descripción
`create`	`POST /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME`	Sube una nueva tabla.
`update`	`PUT /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME`	Reemplazar una tabla existente.
`read`	`GET /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME`	Descargue una tabla que se cargó anteriormente.
`delete`	`DELETE /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME`	Eliminar la tabla dada.
`list`	`GET /v1/accounts/YOUR_ACCOUNT_ID`	Enumere las tablas actualizadas previamente para esta cuenta.

Las variables requeridas en los extremos de API de búsqueda NRQL anteriores se definen a continuación.

Variable	Tipo	Descripción
`YOUR_ACCOUNT_ID`	`number`	La cuenta a la que pertenece la tabla.
`TABLE_NAME`	`string`	Un nombre para la tabla almacenada. Los nombres de las mesas deben cumplir con los estándares de tipo evento personalizado: Longitud máxima: 255 Puede ser una combinación de caracteres alfanuméricos, guiones bajos y dos puntos.

Variable

Tipo

Descripción

YOUR_ACCOUNT_ID

number

La cuenta a la que pertenece la tabla.

TABLE_NAME

string

Un nombre para la tabla almacenada. Los nombres de las mesas deben cumplir con los estándares de tipo evento personalizado:

Longitud máxima: 255
Puede ser una combinación de caracteres alfanuméricos, guiones bajos y dos puntos.

Autenticación

Su sirve para autenticar su solicitud en la API de búsquedas NRQL y debe pasarse como un encabezado HTTP.

Encabezamiento	Valores admitidos
`Api-Key`	Una New Relic .

Crear/actualizar una tabla

Extremo HTTP

Crear

POST /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME

Se utiliza para cargar una nueva tabla. La tabla no puede existir ya. Si es así, esta llamada generará una respuesta 400 Bad Request .

Actualizar

PUT /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME

Se utiliza para reemplazar una tabla existente. Si la tabla no existe, esta llamada generará una respuesta 404 Not Found .

Solicitar parámetro de consulta

Nombre	Tipo	Por defecto	Descripción
`includeTable`	`boolean`	`false`	Indica si se debe incluir el valor de la tabla en la respuesta.

Encabezados HTTP

Al crear sus encabezados HTTP, utilice estas pautas:

Encabezamiento	Valores admitidos
`Content-Type`	`multipart/form-data` `application/json`
`Accept`	`application/json`

Cuerpo de solicitud

Los datos que envía en el cuerpo de su solicitud pueden ser multipart/form-data o application/json.

Campos admitidos

Puede proporcionar los siguientes campos en sus solicitudes de creación y actualización al enviar contenido multipart/form-data :

Campo	Tipo de valor	Requerido	Descripción
`table`	archivo CSV	Sí	Parte de datos de formulario de varias partes que contiene el contenido CSV. Nuestra lógica de análisis de CSV se describe en detalle aquí.
`description`	`string`	No	Segunda parte de datos del formulario de varias partes que contiene una descripción de la tabla.

Ejemplo de carga

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

Campos admitidos

Puede proporcionar los siguientes campos en su creación y actualización al enviar contenido application/json :

Campo

Tipo de valor

Requerido

Descripción

table

JSON

Sí

`headers`	Una matriz de `string` valores que representan los nombres de las columnas de la tabla
`rows`	Una matriz de matrices, que representan los valores de la tabla. Todos los valores deben ser valores `string`, `number` o `boolean` . (No se permiten objetos JSON complejos).

description

string

Una descripción detallada de la tabla.

Ejemplo de carga

{
  "table": {
    "headers": ["id", "name", "text", "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."
}

Cuerpo de respuesta

Si la solicitud se realiza correctamente, la carga útil JSON de respuesta puede incluir los siguientes campos:

Campo

Tipo de valor

Descripción

accountId

number

La cuenta a la que pertenece la tabla. Esto coincidirá con el valor de la cuenta en la ruta.

name

string

Un nombre para la tabla almacenada. Esto coincidirá con el valor del nombre en la ruta.

description

string

Una descripción detallada de la tabla.

guid

string

La guía asignada a la tabla al momento de su creación.

size

number

Tamaño de la tabla como cadena CSV.

rows

number

El número de filas de la tabla (excluida la fila del encabezado)

updatedBy

string

El nombre de usuario/dirección de correo electrónico del último usuario que creó o actualizó por última vez esta tabla.

updatedAt

string

La marca de timestamp de cuándo se creó o actualizó la tabla por última vez. Esto reflejará la última timestamp actualizada del objeto S3. El valor será una cadena de fecha y hora estándar ISO 8601 (ej. 2023-02-13T19:49:28.023Z)

table

JSON objeto literal

`headers`	Una matriz de `string` valores que representan los nombres de las columnas de la tabla
`rows`	Una matriz de matrices, que representan los valores de la tabla.

Ejemplo de carga útil JSON de respuesta

{
  "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]
    ]
  }
}

Solicitudes de ejemplo

Para crear una nueva tabla de búsquedas, podemos enviar una solicitud POST al extremo de creación con una carga útil JSON que describe la tabla de búsquedas.

Aquí hay un ejemplo de comando 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."
$  }'

Para reemplazar una tabla de búsquedas existente, podemos enviar una solicitud PUT al extremo de actualización con un cuerpo de solicitud multipart/form-data que contenga la nueva tabla.

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."

Leer una tabla

Extremo HTTP

GET /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME

Se utiliza para descargar una tabla que se cargó previamente. Si la tabla no existe, esta llamada generará una respuesta 404 Not Found . Este extremo no tiene carga útil de solicitud.

Solicitar parámetro de consulta

Nombre	Tipo	Por defecto	Descripción
`includeTable`	`boolean`	`false`	Indica si se debe incluir el valor de la tabla en la respuesta. Se ignora cuando el tipo de contenido es `text/csv`.

Encabezados HTTP

Al crear sus encabezados HTTP, utilice estas pautas:

Encabezamiento	Valores admitidos
`Accept`	`application/json` `text/csv`

Cuerpo de respuesta

Si la solicitud tiene éxito, la respuesta puede ser del tipo application/json o text/csv.

Respuesta con tipo `application/json`

La respuesta será la misma que la carga útil de respuesta de creación/actualización.

Respuesta con tipo `text/csv`

La respuesta contendrá la tabla en formato CSV.

Solicitudes de ejemplo

Para descargar una tabla que fue cargada previamente, podemos enviar una solicitud GET al extremo de actualización.

Aquí hay un ejemplo de comando 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'

A continuación se muestra un ejemplo de respuesta 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

Eliminar una tabla

Extremo HTTP

DELETE /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME

Se utiliza para eliminar la tabla dada. Si la tabla no existe, esta llamada generará una respuesta 404 Not Found . Este extremo no tiene carga útil de solicitud.

Importante

Las tablas eliminadas no son recuperables.

Solicitar parámetro de consulta

Nombre	Tipo	Por defecto	Descripción
`includeTable`	`boolean`	`false`	Indica si se debe incluir el valor de la tabla en la respuesta.

Encabezados HTTP

Al crear sus encabezados HTTP, utilice estas pautas:

Encabezamiento	Valores admitidos
`Accept`	`application/json`

Cuerpo de respuesta

Si la solicitud se realiza correctamente y el encabezado Accept está configurado en application/json, el cuerpo de la respuesta será el mismo que la carga útil de la respuesta de creación/actualización.

Solicitudes de ejemplo

Para eliminar una tabla que se cargó anteriormente, podemos enviar una solicitud ELIMINAR al extremo de eliminación.

Aquí hay un ejemplo de comando 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'\

Listar tablas

Extremo HTTP

GET /v1/accounts/YOUR_ACCOUNT_ID

Enumera las tablas actualizadas previamente para esta cuenta. Este extremo no tiene carga útil de solicitud.

Encabezados HTTP

Al crear sus encabezados HTTP, utilice estas pautas:

Encabezamiento	Valores admitidos
`Accept`	`application/json`

Cuerpo de respuesta

Si la solicitud tiene éxito, la carga útil JSON de respuesta consistirá en una matriz de resúmenes de tablas. Cada resumen de tabla puede incluir los campos siguientes.

Campo	Tipo de valor	Descripción
`accountId`	`number`	La cuenta a la que pertenece la tabla. Esto coincidirá con el valor de la cuenta en la ruta.
`name`	`string`	Un nombre para la tabla almacenada. Esto coincidirá con el valor del nombre en la ruta.
`description`	`string`	Una descripción más detallada de la tabla.
`guid`	`string`	La guía asignada a la tabla al momento de su creación.
`size`	`number`	El tamaño de la tabla como una cadena CSV.
`rows`	`number`	El número de filas de la tabla (excluida la fila del encabezado)
`updateBy`	`string`	El nombre de usuario/dirección de correo electrónico del último usuario que actualizó esta tabla.
`updatedAt`	`string`	La marca de timestamp de cuándo se creó o actualizó la tabla por última vez. Esto reflejará la última timestamp actualizada del objeto S3. El valor será una cadena de fecha y hora estándar ISO 8601 (ej. 2023-02-13T19:49:28.023Z)

Solicitud de ejemplo

Para enumerar las tablas de una cuenta, podemos enviar una solicitud GET al extremo de la lista.

Aquí hay un ejemplo de comando curl:

bash

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

Aquí hay un ejemplo de carga útil JSON de respuesta:

[
  {
    "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"
  }
]

Mensaje de error

Si una solicitud no tiene éxito, la carga útil de respuesta de error tendrá el siguiente formato.

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

Te ofrecemos esta traducción automática para facilitar la lectura.

Antes de que empieces.css-21sua1{background:none;border:none;width:0;padding:0;}

Extremo HTTP

URL base

Extremo

Autenticación

Crear/actualizar una tabla

Extremo HTTP

Crear

Actualizar

Solicitar parámetro de consulta

Encabezados HTTP

Cuerpo de solicitud

Solicitar con aplicación/json

Cuerpo de respuesta

Ejemplo de carga útil JSON de respuesta

Solicitudes de ejemplo

Crear una nueva tabla

Actualizar una tabla existente

Leer una tabla

Extremo HTTP

Solicitar parámetro de consulta

Encabezados HTTP

Cuerpo de respuesta

Respuesta con tipo application/json

Respuesta con tipo text/csv

Solicitudes de ejemplo

Descargar una tabla existente

Eliminar una tabla

Extremo HTTP

Importante

Solicitar parámetro de consulta

Encabezados HTTP

Cuerpo de respuesta

Solicitudes de ejemplo

Eliminar una tabla existente

Listar tablas

Extremo HTTP

Encabezados HTTP

Cuerpo de respuesta

Solicitud de ejemplo

Tablas de listado actualizadas para una cuenta

Mensaje de error

Antes de que empieces

Respuesta con tipo `application/json`

Respuesta con tipo `text/csv`