Query - Resource Execute Xms

Referenz

Dienst:: Log Analytics

API-Version:: 2022-10-27_Preview

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

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	Optional. Der bevorzugte Header zum Festlegen von Servertimeout, Abfragestatistiken und Visualisierungsinformationen.

Anforderungstext

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

Antworten

Name	Typ	Beschreibung
200 OK	queryResults	OK. Der API-Aufruf war erfolgreich, und das Analytics-Abfrageergebnis 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

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 Analytics-Abfrage. Weitere Informationen zur Analytics-Abfragesyntax
queryResults	Eine Abfrageantwort.
Render	Visualisierungsdaten im JSON-Format.
Statistics	Statistiken werden im JSON-Format dargestellt.
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 maschinenlesbarer 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

queryBody

Die Analytics-Abfrage. Weitere Informationen zur Analytics-Abfragesyntax

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

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	Statistiken werden im JSON-Format dargestellt.
tables	table[]	Die Liste der Tabellen, Spalten und Zeilen.

Render

Visualisierungsdaten im JSON-Format.

Statistics

Statistiken werden im JSON-Format dargestellt.

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.

Freigeben über