Query - Resource Execute

Servicio:

Log Analytics

Versión de la API:

2022-10-27_Preview

Ejecución de una consulta de Analytics mediante el identificador de recurso
Ejecuta una consulta de Analytics para los datos en el contexto de un recurso. Aquí es un ejemplo para usar POST con una consulta de Analytics.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
resourceId	path	True	string	Identificador del recurso.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Prefer		string	Opcional. El 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 sobre 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	De acuerdo. 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 de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

simple-query

Solicitud de ejemplo

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

Respuesta de muestra

status code:

200

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

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	La consulta analytics. Obtenga 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

Object

Una columna de tabla.

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

errorDetail

Object

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 para personas.
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

Object

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 para personas.

errorResponse

Object

Detalles del error.

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

logsColumnType

Enumeración

Tipo de datos de esta columna.

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

queryBody

Object

La consulta analytics. Obtenga 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 sobre 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

Object

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

Object

Datos de visualización en formato JSON.

Statistics

Object

Estadísticas representadas en formato JSON.

table

Object

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.