Query - Resource Execute

Referência

Serviço:: Log Analytics

Versão da API:: 2022-10-27_Preview

Executar uma consulta do Analytics com o ID de recurso
Executa uma consulta de Análise para dados no contexto de um recurso. Eis um exemplo para utilizar POST com uma consulta de Análise.

POST https://api.loganalytics.io/v1/{resourceId}/query

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
resourceId	path	True	string	O identificador do recurso.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
Prefer		string	Opcional. O cabeçalho preferencial para definir o tempo limite do servidor, as estatísticas de consulta e as informações de visualização.

Corpo do Pedido

Name	Necessário	Tipo	Description
query	True	string	A consulta a executar.
timespan		string	Opcional. O período de tempo sobre o qual consultar dados. Trata-se de um valor ISO8601 período de tempo. Este intervalo de tempo é aplicado para além de todos os especificados na expressão de consulta.
workspaces		string[]	Uma lista de áreas de trabalho incluídas na consulta.

Respostas

Name	Tipo	Description
200 OK	queryResults	OK. A chamada à API foi efetuada com êxito e o resultado da consulta do Analytics está no payload de resposta
Other Status Codes	errorResponse	Um objeto de resposta de erro.

Segurança

oauth2

Fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

simple-query

Pedido de amostra

HTTP

POST https://api.loganalytics.io/v1//subscriptions/fffa080af-c2d8-40ad-9cce-e1a450bawb57/resourceGroups/test-resourcegroup/providers/Microsoft.Storage/storageAccounts/storageaccountname/query

{
  "query": "StorageBlobLogs | summarize count() by OperationName | top 10 by count_ desc",
  "timespan": "PT24H"
}

Resposta da amostra

Código de estado:: 200

{
  "tables": [
    {
      "name": "PrimaryResult",
      "columns": [
        {
          "name": "OperationName",
          "type": "string"
        },
        {
          "name": "count_",
          "type": "long"
        }
      ],
      "rows": [
        [
          "operation1",
          "10"
        ]
      ]
    }
  ]
}

Definições

Name	Description
column	Uma coluna de tabela.
errorDetail	Detalhes do erro.
errorInfo	O código e a mensagem de um erro.
errorResponse	Detalhes do erro.
logsColumnType	O tipo de dados desta coluna.
queryBody	A consulta Análise. Saiba mais sobre a sintaxe da consulta do Analytics
queryResults	Uma resposta de consulta.
Render	Dados de visualização no formato JSON.
Statistics	Estatísticas representadas no formato JSON.
table	Uma tabela de resposta de consulta.

column

Uma coluna de tabela.

Name	Tipo	Description
name	string	O nome desta coluna.
type	logsColumnType	O tipo de dados desta coluna.

errorDetail

Detalhes do erro.

Name	Tipo	Description
additionalProperties	object	Propriedades adicionais que podem ser fornecidas no objeto de detalhes do erro
code	string	O código do erro.
message	string	Uma mensagem de erro legível por humanos.
resources	string[]	Indica os recursos responsáveis pelo erro.
target	string	Indica que propriedade no pedido é responsável pelo erro.
value	string	Indica qual o valor em "destino" responsável pelo erro.

errorInfo

O código e a mensagem de um erro.

Name	Tipo	Description
additionalProperties	object	Propriedades adicionais que podem ser fornecidas no objeto de informações de erro
code	string	Um código de erro legível por computador.
details	errorDetail[]	detalhes do erro.
innererror	errorInfo	O código e a mensagem de um erro. Detalhes do erro interno se existirem.
message	string	Uma mensagem de erro legível por humanos.

errorResponse

Detalhes do erro.

Name	Tipo	Description
error	errorInfo	O código e a mensagem de um erro. Os detalhes do erro.

logsColumnType

O tipo de dados desta coluna.

Name	Tipo	Description
bool	string
datetime	string
decimal	string
dynamic	string
guid	string
int	string
long	string
real	string
string	string
timespan	string

queryBody

A consulta Análise. Saiba mais sobre a sintaxe da consulta do Analytics

Name	Tipo	Description
query	string	A consulta a executar.
timespan	string	Opcional. O período de tempo sobre o qual consultar dados. Trata-se de um valor ISO8601 período de tempo. Este intervalo de tempo é aplicado para além de todos os especificados na expressão de consulta.
workspaces	string[]	Uma lista de áreas de trabalho incluídas na consulta.

queryResults

Uma resposta de consulta.

Name	Tipo	Description
error	errorInfo	O código e a mensagem de um erro.
render	Render	Dados de visualização no formato JSON.
statistics	Statistics	Estatísticas representadas no formato JSON.
tables	table[]	A lista de tabelas, colunas e linhas.

Render

Dados de visualização no formato JSON.

Statistics

Estatísticas representadas no formato JSON.

table

Uma tabela de resposta de consulta.

Name	Tipo	Description
columns	column[]	A lista de colunas nesta tabela.
name	string	O nome da tabela.
rows	object[]	As linhas resultantes desta consulta.

Partilhar via