API de pesquisas NRQL

Use a API NRQL Lookups para criar e gerenciar tabela de consulta.

Antes que você comece

A API NRQL Lookups é uma API REST que permite gerenciar tabela de consulta de forma programática. Como outra opção você também pode gerenciar tabela de consulta através de nossa interface.

Ponto de extremidade HTTP

URL base

Use o URL base aplicável à sua conta New Relic em sua chamada de API.

Endpoint dos Estados Unidos (EUA):

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

DaUnião Europeia (UE): endpoint

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

Ponto final

Método	Endpoint	Descrição
`create`	`POST /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME`	Carregue uma nova tabela.
`update`	`PUT /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME`	Substitua uma tabela existente.
`read`	`GET /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME`	Baixe uma tabela que foi carregada anteriormente.
`delete`	`DELETE /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME`	Exclua a tabela fornecida.
`list`	`GET /v1/accounts/YOUR_ACCOUNT_ID`	Liste as tabelas atualizadas anteriormente para esta conta.

As variáveis necessárias nos endpoints de API de pesquisas NRQL acima são definidas abaixo.

Variável	Tipo	Descrição
`YOUR_ACCOUNT_ID`	`number`	A conta à qual a tabela pertence
`TABLE_NAME`	`string`	Um nome para a tabela armazenada. Os nomes das tabelas devem estar em conformidade com os padrões de tipo de evento personalizado: Comprimento máximo: 255 Pode ser uma combinação de caracteres alfanuméricos, sublinhados e dois pontos.

Variável

Tipo

Descrição

YOUR_ACCOUNT_ID

number

A conta à qual a tabela pertence

TABLE_NAME

string

Um nome para a tabela armazenada. Os nomes das tabelas devem estar em conformidade com os padrões de tipo de evento personalizado:

Comprimento máximo: 255
Pode ser uma combinação de caracteres alfanuméricos, sublinhados e dois pontos.

Autenticação

Seu serve para autenticar sua solicitação para a API NRQL Lookups e precisa ser passado como um cabeçalho HTTP.

Cabeçalho	Valores suportados
`Api-Key`	Uma New Relic .

Criar/atualizar uma tabela

Ponto de extremidade HTTP

Criar

POST /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME

Usado para fazer upload de uma nova tabela. A tabela já não pode existir. Se isso acontecer, esta chamada resultará em uma resposta 400 Bad Request .

Atualizar

PUT /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME

Usado para substituir uma tabela existente. Se a tabela não existir, esta chamada resultará em uma resposta 404 Not Found .

Parâmetro de consulta de solicitação

Nome	Tipo	Padrão	Descrição
`includeTable`	`boolean`	`false`	Indica se o valor da tabela deve ser incluído na resposta.

Cabeçalhos HTTP

Ao criar seus cabeçalhos HTTP, use estas diretrizes:

Cabeçalho	Valores suportados
`Content-Type`	`multipart/form-data` `application/json`
`Accept`	`application/json`

Corpo da Solicitação

Os dados que você envia no corpo da sua solicitação podem ser multipart/form-data ou application/json.

Campos Suportados

Você pode fornecer os seguintes campos em suas solicitações de criação e atualização ao enviar conteúdo de multipart/form-data :

Campo	Tipo de valor	Obrigatório	Descrição
`table`	Arquivo CSV	Sim	Parte de dados de formulário multipartes que contém o conteúdo CSV. Nossa lógica de análise de CSV é descrita em detalhes aqui.
`description`	`string`	Não	Segunda parte de dados de formulário multiparte que contém uma descrição da tabela.

Exemplo de carga útil

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

Você pode fornecer os seguintes campos em sua criação e atualização ao enviar conteúdo application/json :

Campo

Tipo de valor

Obrigatório

Descrição

table

JSON

Sim

`headers`	Uma matriz de valores `string` que representa os nomes das colunas da tabela
`rows`	Uma matriz de arrays, representando os valores da tabela. Todos os valores devem ser valores `string`, `number` ou `boolean` . (Objetos JSON complexos não são permitidos.)

description

string

Não

Uma descrição detalhada da tabela

Exemplo de carga útil

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

Corpo de Resposta

Se a solicitação for bem-sucedida, a carga JSON de resposta poderá incluir os seguintes campos:

Campo

Tipo de valor

Descrição

accountId

number

A conta à qual a tabela pertence. Isso corresponderá ao valor da conta no caminho.

name

string

Um nome para a tabela armazenada. Isso corresponderá ao valor do nome no caminho.

description

string

Uma descrição detalhada da tabela

guid

string

O guia atribuído à tabela na criação.

size

number

Tamanho da tabela como uma string CSV.

rows

number

O número de linhas na tabela (excluindo a linha do cabeçalho)

updatedBy

string

O nome de usuário/endereço de e-mail do último usuário que criou ou atualizou esta tabela pela última vez.

updatedAt

string

O carimbo de timestamp de quando a tabela foi criada ou atualizada pela última vez. Isso refletirá o timestamp da última atualização do objeto S3. O valor será uma sequência de data e hora padrão ISO 8601 (ex. 2023-02-13T19:49:28.023Z)

table

JSON objeto literal

`headers`	Uma matriz de valores `string` que representa os nomes das colunas da tabela
`rows`	Uma matriz de arrays, representando os valores da tabela.

Exemplo de carga JSON de resposta

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

Solicitações de exemplo

Para criar uma nova tabela de consulta, podemos enviar uma solicitação POST para o endpoint create com um payload JSON descrevendo a tabela de consulta.

Aqui está um exemplo 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 substituir uma tabela de consulta existente, podemos enviar uma solicitação PUT ao endpoint de atualização com um corpo de solicitação multipart/form-data contendo a nova tabela.

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

Leia uma tabela

Endpoint HTTP

GET /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME

Usado para baixar uma tabela que foi carregada anteriormente. Se a tabela não existir, esta chamada resultará em uma resposta 404 Not Found . Este endpoint não tem carga útil de solicitação.

Parâmetro de consulta de solicitação

Nome	Tipo	Padrão	Descrição
`includeTable`	`boolean`	`false`	Indica se o valor da tabela deve ser incluído na resposta. Ignorado quando o tipo de conteúdo é `text/csv`.

Cabeçalhos HTTP

Ao criar seus cabeçalhos HTTP, use estas diretrizes:

Cabeçalho	Valores suportados
`Accept`	`application/json` `text/csv`

Corpo de Resposta

Se a solicitação for bem-sucedida, a resposta poderá ser do tipo application/json ou text/csv.

Resposta com tipo `application/json`

A resposta será igual à carga útil da resposta de criação/atualização.

Resposta com tipo `text/csv`

A resposta conterá a tabela em formato CSV.

Solicitações de exemplo

Para baixar uma tabela que foi carregada anteriormente, podemos enviar uma solicitação GET ao endpoint de atualização.

Aqui está um exemplo 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'

Aqui está um exemplo de resposta 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

Excluir uma tabela

Endpoint HTTP

DELETE /v1/accounts/YOUR_ACCOUNT_ID/TABLE_NAME

Usado para excluir a tabela fornecida. Se a tabela não existir, esta chamada resultará em uma resposta 404 Not Found . Este endpoint não tem carga útil de solicitação.

Importante

As tabelas excluídas não são recuperáveis.

Parâmetro de consulta de solicitação

Nome	Tipo	Padrão	Descrição
`includeTable`	`boolean`	`false`	Indica se o valor da tabela deve ser incluído na resposta.

Cabeçalhos HTTP

Ao criar seus cabeçalhos HTTP, use estas diretrizes:

Cabeçalho	Valores suportados
`Accept`	`application/json`

Corpo de Resposta

Se a solicitação for bem-sucedida e o cabeçalho Accept estiver definido como application/json, o corpo da resposta será o mesmo da resposta de criação/atualização carga.

Solicitações de exemplo

Para excluir uma tabela que foi carregada anteriormente, podemos enviar uma solicitação DELETE ao endpoint de exclusão.

Aqui está um exemplo 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 tabelas

Endpoint HTTP

GET /v1/accounts/YOUR_ACCOUNT_ID

Lista as tabelas atualizadas anteriormente para esta conta. Este endpoint não tem carga útil de solicitação.

Cabeçalhos HTTP

Ao criar seus cabeçalhos HTTP, use estas diretrizes:

Cabeçalho	Valores suportados
`Accept`	`application/json`

Corpo de Resposta

Se a solicitação for bem-sucedida, a carga JSON de resposta consistirá em uma matriz de resumos de tabelas. Cada resumo da tabela pode incluir os campos abaixo.

Campo	Tipo de valor	Descrição
`accountId`	`number`	A conta à qual a tabela pertence. Isso corresponderá ao valor da conta no caminho.
`name`	`string`	Um nome para a tabela armazenada. Isso corresponderá ao valor do nome no caminho.
`description`	`string`	Uma descrição mais detalhada da tabela
`guid`	`string`	O guia atribuído à tabela na criação.
`size`	`number`	O tamanho da tabela como uma string CSV.
`rows`	`number`	O número de linhas na tabela (excluindo a linha do cabeçalho)
`updateBy`	`string`	O nome de usuário/endereço de e-mail do último usuário que atualizou esta tabela.
`updatedAt`	`string`	O carimbo de timestamp de quando a tabela foi criada ou atualizada pela última vez. Isso refletirá o timestamp da última atualização do objeto S3. O valor será uma sequência de data e hora padrão ISO 8601 (ex. 2023-02-13T19:49:28.023Z)

Exemplo de solicitação

Para listar as tabelas de uma conta, podemos enviar uma solicitação GET ao endpoint da lista.

Aqui está um exemplo 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'

Aqui está um exemplo de carga JSON de resposta:

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

Mensagem de erro

Se uma solicitação não for bem-sucedida, a carga útil da resposta de erro estará no formato abaixo.

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

Esta tradução de máquina é fornecida para sua comodidade.

Antes que você comece.css-21sua1{background:none;border:none;width:0;padding:0;}

Ponto de extremidade HTTP

URL base

Ponto final

Autenticação

Criar/atualizar uma tabela

Ponto de extremidade HTTP

Criar

Atualizar

Parâmetro de consulta de solicitação

Cabeçalhos HTTP

Corpo da Solicitação

Solicitar com aplicativo/json

Corpo de Resposta

Exemplo de carga JSON de resposta

Solicitações de exemplo

Crie uma nova tabela

Atualizar uma tabela existente

Leia uma tabela

Endpoint HTTP

Parâmetro de consulta de solicitação

Cabeçalhos HTTP

Corpo de Resposta

Resposta com tipo application/json

Resposta com tipo text/csv

Solicitações de exemplo

Baixe uma tabela existente

Excluir uma tabela

Endpoint HTTP

Importante

Parâmetro de consulta de solicitação

Cabeçalhos HTTP

Corpo de Resposta

Solicitações de exemplo

Excluir uma tabela existente

Listar tabelas

Endpoint HTTP

Cabeçalhos HTTP

Corpo de Resposta

Exemplo de solicitação

Listando tabelas atualizadas para uma conta

Mensagem de erro

Antes que você comece

Resposta com tipo `application/json`

Resposta com tipo `text/csv`