Query - Resource Execute

Dienst:

Log Analytics

API-Version:

2022-10-27_Preview

Ausführen einer Analyseabfrage mithilfe der Ressourcen-ID
Führt eine Analyseabfrage für Daten im Kontext einer Ressource aus. Hier ist ein Beispiel für die Verwendung von POST mit einer Analyseabfrage.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceId	path	True	string	Der Bezeichner der Ressource.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Prefer		string	Wahlfrei. Der Bevorzugte Header zum Festlegen von Servertimeouts, Abfragestatistiken und Visualisierungsinformationen.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
query	True	string	Die auszuführende Abfrage.
timespan		string	Wahlfrei. Der Zeitbereich, über den Daten abfragt werden sollen. Dies ist ein ISO8601 Zeitraumwert. Dieser Zeitbereich wird zusätzlich zu allen im Abfrageausdruck angegebenen Daten angewendet.
workspaces		string[]	Eine Liste der Arbeitsbereiche, die in der Abfrage enthalten sind.

Antworten

Name	Typ	Beschreibung
200 OK	queryResults	OKAY. Der API-Aufruf war erfolgreich, und das Analyseabfrageergebnis befindet sich in der Antwortnutzlast.
Other Status Codes	errorResponse	Ein Fehlerantwortobjekt.

Sicherheit

oauth2

Azure Active Directory OAuth2-Fluss

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

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

simple-query

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

200

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

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.
queryBody	Die Analyseabfrage. Weitere Informationen zur Analytics-Abfragesyntax
queryResults	Eine Abfrageantwort.
Render	Visualisierungsdaten im JSON-Format.
Statistics	Statistiken, die im JSON-Format dargestellt werden.
table	Eine Abfrageantworttabelle.

column

Objekt

Eine Tabellenspalte.

Name	Typ	Beschreibung
name	string	Der Name dieser Spalte.
type	logsColumnType	Der Datentyp dieser Spalte.

errorDetail

Objekt

Fehlerdetails.

Name	Typ	Beschreibung
additionalProperties	object	Zusätzliche Eigenschaften, die für das Fehlerdetails-Objekt bereitgestellt werden können
code	string	Der Code des Fehlers.
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

Objekt

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, falls vorhanden.
message	string	Eine lesbare Fehlermeldung.

errorResponse

Objekt

Fehlerdetails.

Name	Typ	Beschreibung
error	errorInfo	Der Code und die Meldung für einen Fehler. Die Fehlerdetails.

logsColumnType

Enumeration

Der Datentyp dieser Spalte.

Wert	Beschreibung
bool
datetime
decimal
dynamic
guid
int
long
real
string
timespan

queryBody

Objekt

Die Analyseabfrage. Weitere Informationen zur Analytics-Abfragesyntax

Name	Typ	Beschreibung
query	string	Die auszuführende Abfrage.
timespan	string	Wahlfrei. Der Zeitbereich, über den Daten abfragt werden sollen. Dies ist ein ISO8601 Zeitraumwert. Dieser Zeitbereich wird zusätzlich zu allen im Abfrageausdruck angegebenen Daten angewendet.
workspaces	string[]	Eine Liste der Arbeitsbereiche, die in der Abfrage enthalten sind.

queryResults

Objekt

Eine Abfrageantwort.

Name	Typ	Beschreibung
error	errorInfo	Der Code und die Meldung für einen Fehler.
render	Render	Visualisierungsdaten im JSON-Format.
statistics	Statistics	Statistiken, die im JSON-Format dargestellt werden.
tables	table[]	Die Liste der Tabellen, Spalten und Zeilen.

Render

Objekt

Visualisierungsdaten im JSON-Format.

Statistics

Objekt

Statistiken, die im JSON-Format dargestellt werden.

table

Objekt

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.