Query - Execute

Reference

Služba:: Log Analytics

Verze rozhraní API:: 2022-10-27_Preview

Spuštění analytického dotazu
Spustí analytický dotaz na data. Tady je příklad použití POST s analytickým dotazem.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
workspaceId	path	True	string	ID pracovního prostoru. Toto je ID pracovního prostoru v okně Vlastnosti v Azure Portal.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Prefer		string	Nepovinný parametr. Preferuje hlavičku k nastavení časového limitu serveru, statistiky dotazů a informací o vizualizaci.

Text požadavku

Name	Vyžadováno	Typ	Description
query	True	string	Dotaz, který se má spustit.
timespan		string	Nepovinný parametr. Časový rozsah, pro který se má dotazovat na data. Jedná se o ISO8601 hodnotu časového období. Toto časové rozpětí se použije vedle všech, které jsou zadány ve výrazu dotazu.
workspaces		string[]	Seznam pracovních prostorů, které jsou součástí dotazu.

Odpovědi

Name	Typ	Description
200 OK	queryResults	OK. Volání rozhraní API bylo úspěšné a výsledek dotazu Analytics je v datové části odpovědi.
Other Status Codes	errorResponse	Objekt odpovědi na chybu.

Zabezpečení

oauth2

Tok Azure Active Directory OAuth2

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

cross-workspace

simple-query

cross-workspace

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 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

Ukázkový požadavek

HTTP

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

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

Ukázková odpověď

Stavový kód:: 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"
        ]
      ]
    }
  ]
}

Definice

Name	Description
column	Sloupec tabulky.
errorDetail	Podrobnosti o chybě.
errorInfo	Kód a zpráva pro chybu.
errorResponse	Podrobnosti o chybě.
logsColumnType	Datový typ tohoto sloupce.
queryBody	Analytický dotaz. Další informace o syntaxi dotazů Analytics
queryResults	Odpověď na dotaz.
Render	Vizualizační data ve formátu JSON.
Statistics	Statistika reprezentovaná ve formátu JSON
table	Tabulka odpovědí na dotaz.

column

Sloupec tabulky.

Name	Typ	Description
name	string	Název tohoto sloupce.
type	logsColumnType	Datový typ tohoto sloupce.

errorDetail

Podrobnosti o chybě.

Name	Typ	Description
additionalProperties	object	Další vlastnosti, které lze zadat u objektu podrobností o chybě
code	string	Kód chyby.
message	string	Chybová zpráva čitelná pro člověka.
resources	string[]	Označuje prostředky, které byly zodpovědné za chybu.
target	string	Určuje, která vlastnost v požadavku je zodpovědná za chybu.
value	string	Označuje, která hodnota v "target" je zodpovědná za chybu.

errorInfo

Kód a zpráva pro chybu.

Name	Typ	Description
additionalProperties	object	Další vlastnosti, které lze zadat u objektu informací o chybě
code	string	Strojově čitelný kód chyby.
details	errorDetail[]	podrobnosti o chybě.
innererror	errorInfo	Kód a zpráva pro chybu. Podrobnosti o vnitřní chybě, pokud existují.
message	string	Chybová zpráva čitelná pro člověka.

errorResponse

Podrobnosti o chybě.

Name	Typ	Description
error	errorInfo	Kód a zpráva pro chybu. Podrobnosti o chybě

logsColumnType

Datový typ tohoto sloupce.

Name	Typ	Description
bool	string
datetime	string
decimal	string
dynamic	string
guid	string
int	string
long	string
real	string
string	string
timespan	string

queryBody

Analytický dotaz. Další informace o syntaxi dotazů Analytics

Name	Typ	Description
query	string	Dotaz, který se má spustit.
timespan	string	Nepovinný parametr. Časový rozsah, pro který se má dotazovat na data. Jedná se o ISO8601 hodnotu časového období. Toto časové rozpětí se použije vedle všech, které jsou zadány ve výrazu dotazu.
workspaces	string[]	Seznam pracovních prostorů, které jsou součástí dotazu.

queryResults

Odpověď na dotaz.

Name	Typ	Description
error	errorInfo	Kód a zpráva pro chybu.
render	Render	Vizualizační data ve formátu JSON.
statistics	Statistics	Statistika reprezentovaná ve formátu JSON
tables	table[]	Seznam tabulek, sloupců a řádků.

Render

Vizualizační data ve formátu JSON.

Statistics

Statistika reprezentovaná ve formátu JSON

table

Tabulka odpovědí na dotaz.

Name	Typ	Description
columns	column[]	Seznam sloupců v této tabulce
name	string	Název tabulky.
rows	object[]	Výsledné řádky z tohoto dotazu

Sdílet prostřednictvím

Query - Execute

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

Odpovědi

Zabezpečení

oauth2

Rozsahy

Příklady

cross-workspace

Ukázkový požadavek

Ukázková odpověď

simple-query

Ukázkový požadavek

Ukázková odpověď

Definice

column

errorDetail

errorInfo

errorResponse

logsColumnType

queryBody

queryResults

Render

Statistics

table

Další materiály