Предпочтительные параметры

API поддерживает настройку некоторых параметров запроса и ответа с помощью заголовка Prefer . В этом разделе описывается, как использовать его для настройки каждого предпочтения и соответствующих значений.

Сведения о визуализации

Язык запросов позволяет указать параметры отрисовки. По умолчанию API не возвращает сведения о типе визуализации. Чтобы включить определенную визуализацию, включите этот заголовок:

    Prefer: include-render=true

Этот заголовок включает в ответ свойство render, которое указывает тип выбранной запросом визуализации и все свойства для этой визуализации.

Например, следующий запрос задает визуализацию в формате линейчатой диаграммы с заголовком "Perf events in the last day" (События производительности за последний день):

    POST https://api.loganalytics.azure.com/v1/workspaces/{workspace-id}/query
    Authorization: Bearer <access token>
    Prefer: include-render=true
    Content-Type: application/json
    
    {
        "query": "Perf | summarize count() by bin(TimeGenerated, 4h) | render barchart title='24H Perf events'",
        "timespan": "P1D"
    }

Ответ содержит свойство render с метаданными для выбранной визуализации.

    HTTP/1.1 200 OK
    Content-Type: application/json; charset=utf-8
    
    {
        "tables": [ ...query results... ],
        "render": {
            "visualization": "barchart",
            "title": "24H Perf events",
            "accumulate": false,
            "isQuerySorted": false,
            "kind": "default",
            "annotation": "",
            "by": null
        }
    }

Статистика запросов

Чтобы получить статистические сведения о запросе, включите этот заголовок:

    Prefer: include-statistics=true

Этот заголовок включает в ответ свойство statistics, которое описывает различные статистические данные о производительности, такие как время выполнения запроса и использование ресурсов.

Время ожидания запроса

Время ожидания запроса по умолчанию — 3 минуты. Чтобы настроить время ожидания запроса, задайте wait свойство, как описано здесь.

Запрос источников данных

Чтобы получить сведения о источниках данных запроса — регионах, рабочих областях, кластерах и таблицах, включите следующий заголовок:

    Prefer: include-dataSources=true