Query - Execute

Referência

Serviço:: Log Analytics

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

Executar uma consulta do Analytics
Executa uma consulta do Analytics para dados. Aqui está um exemplo para usar POST com uma consulta de Análise.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
workspaceId	path	True	string	ID do workspace. Essa é a ID do Workspace da folha Propriedades no portal do Azure.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Prefer		string	Opcional. O cabeçalho prefer para definir o tempo limite do servidor, estatísticas de consulta e informações de visualização.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
query	True	string	A consulta a ser executada.
timespan		string	Opcional. O intervalo de tempo sobre o qual consultar dados. Esse é um valor ISO8601 período de tempo. Esse período de tempo é aplicado além de qualquer que seja especificado na expressão de consulta.
workspaces		string[]	Uma lista de workspaces incluídos na consulta.

Respostas

Nome	Tipo	Description
200 OK	queryResults	OK. A chamada à API foi bem-sucedida e o resultado da consulta do Analytics está no conteúdo da resposta
Other Status Codes	errorResponse	Um objeto de resposta de erro.

Segurança

oauth2

Fluxo do OAuth2 do Azure Active Directory

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

cross-workspace

simple-query

cross-workspace

Solicitação de exemplo

HTTP

POST https://api.loganalytics.io/v1/workspaces/63613592-b6f7-4c3d-a390-22ba13102111/query

{
  "query": "union * | where TimeGenerated > ago(1h) | summarize count() by Type, TenantId",
  "workspaces": [
    "draft-test",
    "draft-test-2"
  ]
}

Resposta de exemplo

Código de status:: 200

{
  "tables": [
    {
      "name": "PrimaryResult",
      "columns": [
        {
          "name": "Type",
          "type": "string"
        },
        {
          "name": "TenantId",
          "type": "string"
        },
        {
          "name": "count_",
          "type": "long"
        }
      ],
      "rows": [
        [
          "Usage",
          "63613592-b6f7-4c3d-a390-22ba13102111",
          "1"
        ],
        [
          "Usage",
          "d436f322-a9f4-4aad-9a7d-271fbf66001c",
          "1"
        ],
        [
          "BillingFact",
          "63613592-b6f7-4c3d-a390-22ba13102111",
          "1"
        ],
        [
          "BillingFact",
          "d436f322-a9f4-4aad-9a7d-271fbf66001c",
          "1"
        ],
        [
          "Operation",
          "63613592-b6f7-4c3d-a390-22ba13102111",
          "7"
        ],
        [
          "Operation",
          "d436f322-a9f4-4aad-9a7d-271fbf66001c",
          "5"
        ]
      ]
    }
  ]
}

simple-query

Solicitação de exemplo

HTTP

POST https://api.loganalytics.io/v1/workspaces/63613592-b6f7-4c3d-a390-22ba13102111/query

{
  "query": "Usage | take 10",
  "timespan": "PT12H"
}

Resposta de exemplo

Código de status:: 200

{
  "tables": [
    {
      "name": "PrimaryResult",
      "columns": [
        {
          "name": "TenantId",
          "type": "string"
        },
        {
          "name": "Computer",
          "type": "string"
        },
        {
          "name": "TimeGenerated",
          "type": "datetime"
        },
        {
          "name": "SourceSystem",
          "type": "string"
        },
        {
          "name": "StartTime",
          "type": "datetime"
        },
        {
          "name": "EndTime",
          "type": "datetime"
        },
        {
          "name": "ResourceUri",
          "type": "string"
        },
        {
          "name": "LinkedResourceUri",
          "type": "string"
        },
        {
          "name": "DataType",
          "type": "string"
        },
        {
          "name": "Solution",
          "type": "string"
        },
        {
          "name": "BatchesWithinSla",
          "type": "long"
        },
        {
          "name": "BatchesOutsideSla",
          "type": "long"
        },
        {
          "name": "BatchesCapped",
          "type": "long"
        },
        {
          "name": "TotalBatches",
          "type": "long"
        },
        {
          "name": "AvgLatencyInSeconds",
          "type": "real"
        },
        {
          "name": "Quantity",
          "type": "real"
        },
        {
          "name": "QuantityUnit",
          "type": "string"
        },
        {
          "name": "IsBillable",
          "type": "bool"
        },
        {
          "name": "MeterId",
          "type": "string"
        },
        {
          "name": "LinkedMeterId",
          "type": "string"
        },
        {
          "name": "Type",
          "type": "string"
        }
      ],
      "rows": [
        [
          "b438b4f6-912a-46d5-9cb1-b44069212abc",
          "ContosoSQLSrv1",
          "2017-08-24T06:59:59Z",
          "OMS",
          "2017-08-24T06:00:00Z",
          "2017-08-24T06:59:59Z",
          "/subscriptions/e4272367-5645-4c4e-9c67-3b74b59a6982/resourcegroups/contosoazurehq/providers/microsoft.operationalinsights/workspaces/contosoretail-it",
          null,
          "Perf",
          "LogManagement",
          "1",
          "0",
          "0",
          "1",
          "1.286",
          "0.076408",
          "MBytes",
          "true",
          "a4e29a95-5b4c-408b-80e3-113f9410566e",
          "00000000-0000-0000-0000-000000000000",
          "Usage"
        ],
        [
          "b438b4f6-912a-46d5-9cb1-b44069212abc",
          "Store010Web3",
          "2017-08-24T06:59:59Z",
          "OMS",
          "2017-08-24T06:00:00Z",
          "2017-08-24T06:59:59Z",
          "/subscriptions/e4272367-5645-4c4e-9c67-3b74b59a6982/resourcegroups/contosoazurehq/providers/microsoft.operationalinsights/workspaces/contosoretail-it",
          null,
          "Perf",
          "LogManagement",
          "1",
          "0",
          "0",
          "1",
          "1.7",
          "0.106767",
          "MBytes",
          "true",
          "a4e29a95-5b4c-408b-80e3-113f9410566e",
          "00000000-0000-0000-0000-000000000000",
          "Usage"
        ]
      ]
    }
  ]
}

Definições

Nome	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 dessa coluna.
queryBody	A consulta do Analytics. Saiba mais sobre a sintaxe de 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.

Nome	Tipo	Description
name	string	O nome dessa coluna.
type	logsColumnType	O tipo de dados dessa coluna.

errorDetail

Detalhes do erro.

Nome	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 que foram responsáveis pelo erro.
target	string	Indica qual propriedade na solicitação é responsável pelo erro.
value	string	Indica qual valor em 'target' é responsável pelo erro.

errorInfo

O código e a mensagem de um erro.

Nome	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 do computador.
details	errorDetail[]	detalhes do erro.
innererror	errorInfo	O código e a mensagem de um erro. Detalhes do erro interno se eles existirem.
message	string	Uma mensagem de erro legível por humanos.

errorResponse

Detalhes do erro.

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

logsColumnType

O tipo de dados dessa coluna.

Nome	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 do Analytics. Saiba mais sobre a sintaxe de consulta do Analytics

Nome	Tipo	Description
query	string	A consulta a ser executada.
timespan	string	Opcional. O intervalo de tempo sobre o qual consultar dados. Esse é um valor ISO8601 período de tempo. Esse período de tempo é aplicado além de qualquer que seja especificado na expressão de consulta.
workspaces	string[]	Uma lista de workspaces incluídos na consulta.

queryResults

Uma resposta de consulta.

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

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

Compartilhar via

Query - Execute

Parâmetros de URI

Cabeçalho da solicitação

Corpo da solicitação

Respostas

Segurança

oauth2

Escopos

Exemplos

cross-workspace

Solicitação de exemplo

Resposta de exemplo

simple-query

Solicitação de exemplo

Resposta de exemplo

Definições

column

errorDetail

errorInfo

errorResponse

logsColumnType

queryBody

queryResults

Render

Statistics

table

Recursos adicionais