• EnglishEspañol日本語한국어Português
  • EntrarComeçar agora

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

Caso haja alguma divergência entre a versão em inglês e a traduzida, a versão em inglês prevalece. Acesse esta página para mais informações.

Criar um problema

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.

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.

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

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

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

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

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
}
Copyright © 2024 New Relic Inc.

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.