Query - Execute

Referencia

Service:: Log Analytics

API Version:: 2022-10-27_Preview

Ejecución de una consulta de Analytics
Ejecuta una consulta de Analytics para los datos. Este es un ejemplo de uso de POST con una consulta de Analytics.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
workspaceId	path	True	string	Identificador del área de trabajo. Este es el identificador del área de trabajo de la hoja Propiedades de la Azure Portal.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Prefer		string	Opcional. Encabezado preferido para establecer el tiempo de espera del servidor, las estadísticas de consulta y la información de visualización.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
query	True	string	Consulta que se va a ejecutar.
timespan		string	Opcional. Intervalo de tiempo en el que se van a consultar los datos. Se trata de un valor de período de tiempo ISO8601. Este intervalo de tiempo se aplica además de los especificados en la expresión de consulta.
workspaces		string[]	Lista de áreas de trabajo que se incluyen en la consulta.

Respuestas

Nombre	Tipo	Description
200 OK	queryResults	Aceptar. La llamada API se realizó correctamente y el resultado de la consulta de Analytics se encuentra en la carga de respuesta.
Other Status Codes	errorResponse	Objeto de respuesta de error.

Seguridad

oauth2

Flujo OAuth2 de Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

cross-workspace

simple-query

cross-workspace

Sample Request

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

Sample Response

Status code:: 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

Sample Request

HTTP

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

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

Sample Response

Status code:: 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"
        ]
      ]
    }
  ]
}

Definiciones

Nombre	Description
column	Una columna de tabla.
errorDetail	Detalles del error.
errorInfo	El código y el mensaje de un error.
errorResponse	Detalles del error.
logsColumnType	Tipo de datos de esta columna.
queryBody	Consulta de Analytics. Más información sobre la sintaxis de consulta de Analytics
queryResults	Una respuesta de consulta.
Render	Datos de visualización en formato JSON.
Statistics	Estadísticas representadas en formato JSON.
table	Una tabla de respuesta de consulta.

column

Una columna de tabla.

Nombre	Tipo	Description
name	string	Nombre de esta columna.
type	logsColumnType	Tipo de datos de esta columna.

errorDetail

Detalles del error.

Nombre	Tipo	Description
additionalProperties	object	Propiedades adicionales que se pueden proporcionar en el objeto de detalles de error
code	string	Código del error.
message	string	Mensaje de error legible.
resources	string[]	Indica los recursos responsables del error.
target	string	Indica qué propiedad de la solicitud es responsable del error.
value	string	Indica qué valor de "destino" es responsable del error.

errorInfo

El código y el mensaje de un error.

Nombre	Tipo	Description
additionalProperties	object	Propiedades adicionales que se pueden proporcionar en el objeto de información de error
code	string	Código de error legible de la máquina.
details	errorDetail[]	detalles del error.
innererror	errorInfo	El código y el mensaje de un error. Detalles del error interno si existen.
message	string	Mensaje de error legible.

errorResponse

Detalles del error.

Nombre	Tipo	Description
error	errorInfo	El código y el mensaje de un error. Los detalles del error.

logsColumnType

Tipo de datos de esta columna.

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

queryBody

Consulta de Analytics. Más información sobre la sintaxis de consulta de Analytics

Nombre	Tipo	Description
query	string	Consulta que se va a ejecutar.
timespan	string	Opcional. Intervalo de tiempo en el que se van a consultar los datos. Se trata de un valor de período de tiempo ISO8601. Este intervalo de tiempo se aplica además de los especificados en la expresión de consulta.
workspaces	string[]	Lista de áreas de trabajo que se incluyen en la consulta.

queryResults

Una respuesta de consulta.

Nombre	Tipo	Description
error	errorInfo	El código y el mensaje de un error.
render	Render	Datos de visualización en formato JSON.
statistics	Statistics	Estadísticas representadas en formato JSON.
tables	table[]	Lista de tablas, columnas y filas.

Render

Datos de visualización en formato JSON.

Statistics

Estadísticas representadas en formato JSON.

table

Una tabla de respuesta de consulta.

Nombre	Tipo	Description
columns	column[]	Lista de columnas de esta tabla.
name	string	Nombre de la tabla.
rows	object[]	Filas resultantes de esta consulta.

Query - Execute

Parámetros de identificador URI

Encabezado de la solicitud

Cuerpo de la solicitud

Respuestas

Seguridad

oauth2

Scopes

Ejemplos

cross-workspace

Sample Request

Sample Response

simple-query

Sample Request

Sample Response

Definiciones

column

errorDetail

errorInfo

errorResponse

logsColumnType

queryBody

queryResults

Render

Statistics

table

Recursos adicionales