Query - Get

  • Referenz
Dienst:
Log Analytics
API-Version:
2022-10-27_Preview

Ausführen einer Analytics-Abfrage
Führt eine Analyseabfrage für Daten aus.

GET https://api.loganalytics.io/v1/workspaces/{workspaceId}/query?query={query}
Mit optionalen Parametern: 
GET https://api.loganalytics.io/v1/workspaces/{workspaceId}/query?query={query}&timespan={timespan}

URI-Parameter

Name In Erforderlich Typ Beschreibung
workspaceId
 path True

string

ID des Arbeitsbereichs. Dies ist die Arbeitsbereichs-ID auf dem Blatt Eigenschaften im Azure-Portal.
query
 query True

string

Die Analytics-Abfrage. Weitere Informationen zur Abfragesyntax von Analytics
timespan
 query

string

duration

Optional. Der Zeitraum, über den Daten abfragt werden. Dies ist ein ISO8601 Zeitraumwert. Dieser Zeitraum wird zusätzlich zu allen angewendet, die im Abfrageausdruck angegeben sind.

Antworten

Name Typ Beschreibung
200 OK

queryResults

OK. Der API-Aufruf war erfolgreich, und das Ergebnis der Analyseabfrage befindet sich in der Antwortnutzlast.
Other Status Codes

errorResponse

Ein Fehlerantwortobjekt.

Sicherheit

oauth2

Azure Active Directory-OAuth2-Flow

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name Beschreibung
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

cross-workspace
simple-query

cross-workspace

Beispielanforderung

GET https://api.loganalytics.io/v1/workspaces/63613592-b6f7-4c3d-a390-22ba13102111/query?query=union * | where TimeGenerated > ago(1h) | summarize count() by Type, TenantId

Beispiel für eine Antwort

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

Beispielanforderung

GET https://api.loganalytics.io/v1/workspaces/63613592-b6f7-4c3d-a390-22ba13102111/query?query=Usage | take 10&timespan=PT12H

Beispiel für eine Antwort

Statuscode:
200 
x-ms-request-id: 58a37988-2c05-427a-891f-5e0e1266fcc5
x-ms-correlation-request-id: 58a37988-2c05-427a-891f-5e0e1266fcc5
{
  "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"
        ]
      ]
    }
  ]
}

Definitionen

Name Beschreibung
column

Eine Tabellenspalte.
errorDetail

Fehlerdetails.
errorInfo

Der Code und die Meldung für einen Fehler.
errorResponse

Fehlerdetails.
logsColumnType

Der Datentyp dieser Spalte.
queryResults

Eine Abfrageantwort.
Render

Visualisierungsdaten im JSON-Format.
Statistics

Im JSON-Format dargestellte Statistiken.
table

Eine Abfrageantworttabelle.

column

Eine Tabellenspalte.

Name Typ Beschreibung
name

string

Der Name dieser Spalte.
type

logsColumnType

Der Datentyp dieser Spalte.

errorDetail

Fehlerdetails.

Name Typ Beschreibung
additionalProperties

object

Zusätzliche Eigenschaften, die für das Fehlerdetailsobjekt bereitgestellt werden können
code

string

Der Fehlercode.
message

string

Eine lesbare Fehlermeldung.
resources

string[]

Gibt Ressourcen an, die für den Fehler verantwortlich waren.
target

string

Gibt an, welche Eigenschaft in der Anforderung für den Fehler verantwortlich ist.
value

string

Gibt an, welcher Wert in "target" für den Fehler verantwortlich ist.

errorInfo

Der Code und die Meldung für einen Fehler.

Name Typ Beschreibung
additionalProperties

object

Zusätzliche Eigenschaften, die für das Fehlerinformationsobjekt bereitgestellt werden können
code

string

Ein computerlesbarer Fehlercode.
details

errorDetail[]

Fehlerdetails.
innererror

errorInfo

Der Code und die Meldung für einen Fehler.
Innere Fehlerdetails, sofern vorhanden.
message

string

Eine lesbare Fehlermeldung.

errorResponse

Fehlerdetails.

Name Typ Beschreibung
error

errorInfo

Der Code und die Meldung für einen Fehler.
Die Fehlerdetails.

logsColumnType

Der Datentyp dieser Spalte.

Name Typ Beschreibung
bool

string

datetime

string

decimal

string

dynamic

string

guid

string

int

string

long

string

real

string

string

string

timespan

string

queryResults

Eine Abfrageantwort.

Name Typ Beschreibung
error

errorInfo

Der Code und die Meldung für einen Fehler.
render

Render

Visualisierungsdaten im JSON-Format.
statistics

Statistics

Im JSON-Format dargestellte Statistiken.
tables

table[]

Die Liste der Tabellen, Spalten und Zeilen.

Render

Visualisierungsdaten im JSON-Format.

Statistics

Im JSON-Format dargestellte Statistiken.

table

Eine Abfrageantworttabelle.

Name Typ Beschreibung
columns

column[]

Die Liste der Spalten in dieser Tabelle.
name

string

Der Name der Tabelle.
rows

object[]

Die resultierenden Zeilen aus dieser Abfrage.