Query - Execute

Ссылка

Service:: Log Analytics

API Version:: 2022-10-27_Preview

Выполнение запроса аналитики
Выполняет запрос аналитики для данных. Ниже приведен пример использования POST с запросом Аналитики.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
workspaceId	path	True	string	Идентификатор рабочей области. Это идентификатор рабочей области из колонки Свойства в портал Azure.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Prefer		string	Необязательный элемент. Предпочттельный заголовок для задания времени ожидания сервера, статистики запросов и сведений о визуализации.

Текст запроса

Имя	Обязательно	Тип	Описание
query	True	string	Выполняемый запрос.
timespan		string	Необязательный элемент. Временной диапазон, по которому запрашивают данные. Это ISO8601 значение периода времени. Этот временной диапазон применяется в дополнение к любым значениям, указанным в выражении запроса.
workspaces		string[]	Список рабочих областей, включенных в запрос.

Ответы

Имя	Тип	Описание
200 OK	queryResults	Все в порядке. Вызов API выполнен успешно, и результат запроса Аналитики находится в полезных данных ответа
Other Status Codes	errorResponse	Объект ответа об ошибке.

Безопасность

oauth2

Поток OAuth2 в Azure Active Directory

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

cross-workspace

simple-query

cross-workspace

Sample Request

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

Sample Response

Status code:: 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

Sample Request

HTTP

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

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

Sample Response

Status code:: 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"
        ]
      ]
    }
  ]
}

Определения

Имя	Описание
column	Столбец таблицы.
errorDetail	Сведения об ошибке.
errorInfo	Код и сообщение об ошибке.
errorResponse	Сведения об ошибке.
logsColumnType	Тип данных этого столбца.
queryBody	Запрос Аналитики. Дополнительные сведения о синтаксисе запросов Аналитики
queryResults	Ответ запроса.
Render	Данные визуализации в формате JSON.
Statistics	Статистика, представленная в формате JSON.
table	Таблица ответов на запросы.

column

Столбец таблицы.

Имя	Тип	Описание
name	string	Имя этого столбца.
type	logsColumnType	Тип данных этого столбца.

errorDetail

Сведения об ошибке.

Имя	Тип	Описание
additionalProperties	object	Дополнительные свойства, которые могут быть предоставлены в объекте сведений об ошибке
code	string	Код ошибки.
message	string	Удобочитаемое сообщение об ошибке.
resources	string[]	Указывает ресурсы, которые были ответственны за ошибку.
target	string	Указывает, какое свойство в запросе отвечает за ошибку.
value	string	Указывает, какое значение в target отвечает за ошибку.

errorInfo

Код и сообщение об ошибке.

Имя	Тип	Описание
additionalProperties	object	Дополнительные свойства, которые можно указать в объекте сведений об ошибке
code	string	Код ошибки, доступный для чтения компьютером.
details	errorDetail[]	сведения об ошибке.
innererror	errorInfo	Код и сообщение об ошибке. Сведения о внутренней ошибке, если они существуют.
message	string	Удобочитаемое сообщение об ошибке.

errorResponse

Сведения об ошибке.

Имя	Тип	Описание
error	errorInfo	Код и сообщение об ошибке. Сведения об ошибке.

logsColumnType

Тип данных этого столбца.

Имя	Тип	Описание
bool	string
datetime	string
decimal	string
dynamic	string
guid	string
int	string
long	string
real	string
string	string
timespan	string

queryBody

Запрос Аналитики. Дополнительные сведения о синтаксисе запросов Аналитики

Имя	Тип	Описание
query	string	Выполняемый запрос.
timespan	string	Необязательный элемент. Временной диапазон, по которому запрашивают данные. Это ISO8601 значение периода времени. Этот временной диапазон применяется в дополнение к любым значениям, указанным в выражении запроса.
workspaces	string[]	Список рабочих областей, включенных в запрос.

queryResults

Ответ запроса.

Имя	Тип	Описание
error	errorInfo	Код и сообщение об ошибке.
render	Render	Данные визуализации в формате JSON.
statistics	Statistics	Статистика, представленная в формате JSON.
tables	table[]	Список таблиц, столбцов и строк.

Render

Данные визуализации в формате JSON.

Statistics

Статистика, представленная в формате JSON.

table

Таблица ответов на запросы.

Имя	Тип	Описание
columns	column[]	Список столбцов в этой таблице.
name	string	Имя таблицы.
rows	object[]	Результирующая строка из этого запроса.

Query - Execute

Параметры URI

Заголовок запроса

Текст запроса

Ответы

Безопасность

oauth2

Scopes

Примеры

cross-workspace

Sample Request

Sample Response

simple-query

Sample Request

Sample Response

Определения

column

errorDetail

errorInfo

errorResponse

logsColumnType

queryBody

queryResults

Render

Statistics

table

Дополнительные ресурсы