Partilhar via

Query - Execute

Serviço:
Log Analytics
Versão da API:
2022-10-27_Preview

Executar uma consulta do Google Analytics
Executa uma consulta de dados do Google Analytics. Aqui está um exemplo de uso do POST com uma consulta do Google Analytics.

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

Parâmetros do URI

Name Em Necessário Tipo Description
workspaceId
 path True

string

ID do espaço de trabalho. Esta é a ID do Espaço de Trabalho da folha Propriedades no portal do Azure.

Cabeçalho do Pedido

Name Necessário Tipo Description
Prefer

string

Opcional. O cabeçalho preferido para definir o tempo limite do servidor, estatísticas de consulta e informações de visualização.

Corpo do Pedido

Name Necessário Tipo Description
query True

string

A consulta a ser executada.
timespan

string

Opcional. O período de tempo durante o qual consultar dados. Este é um valor de período de tempo ISO8601. Esse período de tempo é aplicado além de qualquer um especificado na expressão de consulta.
workspaces

string[]

Uma lista de espaços de trabalho incluídos na consulta.

Respostas

Name Tipo Description
200 OK

queryResults

OK. A chamada de API foi bem-sucedida e o resultado da consulta do Google Analytics está na carga útil de resposta
Other Status Codes

errorResponse

Um objeto de resposta de erro.

Segurança

oauth2

Azure Ative Directory OAuth2 Flow

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

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

cross-workspace
simple-query

cross-workspace

Pedido de amostra

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 da amostra

Código de estado:
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

Pedido de amostra

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

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

Resposta da amostra

Código de estado:
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

Name Description
column

Uma coluna de tabela.
errorDetail

Detalhes do erro.
errorInfo

O código e a mensagem para um erro.
errorResponse

Detalhes do erro.
logsColumnType

O tipo de dados desta coluna.
queryBody

A consulta do Google Analytics. Saiba mais sobre a sintaxe de consulta do Analytics
queryResults

Uma resposta de consulta.
Render

Dados de visualização em formato JSON.
Statistics

Estatísticas representadas em formato JSON.
table

Uma tabela de resposta à consulta.

column

Object

Uma coluna de tabela.

Name Tipo Description
name

string

O nome desta coluna.
type

logsColumnType

O tipo de dados desta coluna.

errorDetail

Object

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

Object

O código e a mensagem para 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 máquina.
details

errorDetail[]

detalhes do erro.
innererror

errorInfo

O código e a mensagem para um erro.
Detalhes do erro interno, se existirem.
message

string

Uma mensagem de erro legível por humanos.

errorResponse

Object

Detalhes do erro.

Name Tipo Description
error

errorInfo

O código e a mensagem para um erro.
Os detalhes do erro.

logsColumnType

Enumeração

O tipo de dados desta coluna.

Valor Description
bool
datetime
dynamic
int
long
real
string
guid
decimal
timespan

queryBody

Object

A consulta do Google Analytics. Saiba mais sobre a sintaxe de consulta do Analytics

Name Tipo Description
query

string

A consulta a ser executada.
timespan

string

Opcional. O período de tempo durante o qual consultar dados. Este é um valor de período de tempo ISO8601. Esse período de tempo é aplicado além de qualquer um especificado na expressão de consulta.
workspaces

string[]

Uma lista de espaços de trabalho incluídos na consulta.

queryResults

Object

Uma resposta de consulta.

Name Tipo Description
error

errorInfo

O código e a mensagem para um erro.
render

Render

Dados de visualização em formato JSON.
statistics

Statistics

Estatísticas representadas em formato JSON.
tables

table[]

A lista de tabelas, colunas e linhas.

Render

Object

Dados de visualização em formato JSON.

Statistics

Object

Estatísticas representadas em formato JSON.

table

Object

Uma tabela de resposta à 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.