Запрос данных из службы "Аналитика временных рядов Azure" 2-го поколения

  • Статья

Примечание.

Служба "Аналитика временных рядов" будет прекращена 7 июля 2024 года. Рассмотрите возможность переноса существующих сред в альтернативные решения как можно скорее. Дополнительные сведения об устаревании и миграции см. в нашей документации.

Служба "Аналитика временных рядов" 2-го поколения позволяет запрашивать данные о событиях и метаданных, хранящихся в среде, с помощью API общедоступной поверхности. Эти программные интерфейсы (API) также используются в Azure Time Series Insights TSI Explorer.

Доступны три основные категории API в службе "Аналитика временных рядов Azure" 2-го поколения:

  • API среды. Эти программные интерфейсы (API) позволяют выполнять запросы в самой среде службы "Аналитика временных рядов Azure" 2-го поколения. Их можно использовать для сбора списка сред, к которым у вызывающего объекта есть доступ, и метаданных среды.
  • Программные интерфейсы (API) модели-запроса временных рядов (TSM-Q) позволяют выполнять операции создания, чтения, обновления и удаления (CRUD) в метаданных, хранящихся в модели временных рядов этой среды. Их можно использовать для доступа к экземплярам, типам и иерархиям, а также для их изменения.
  • Программные интерфейсы (API) запроса временных рядов (TSQ) позволяют получать данные телеметрии или событий, так как они записываются от поставщика источника и позволяют выполнять вычисления и агрегирование данных с помощью расширенных скалярных и агрегатных функций.

Служба "Аналитика временных рядов Azure" 2-го поколения использует язык выражений с расширенными строками, выражение временных рядов (TSX) для выражения вычислений в переменных временных рядов.

Общие сведения о программных интерфейсах (API) службы "Аналитика временных рядов Azure" 2-го поколения

Поддерживаются следующие основные программные интерфейсы.

Общие сведения о запросе временных рядов

Программные интерфейсы среды

  • API получения списка сред. Возвращает список сред, к которым вызывающая сторона может получать доступ.
  • API получения доступных событий в среде. Возвращает распределение количества событий по метке времени для событий $ts. Этот API помогает определить наличие в среде каких-либо событий, возвращая количество событий, разбитых на интервалы времени, если они существуют.
  • API получения схемы событий возвращает метаданные схемы событий для заданной области поиска. Этот API позволяет получить все метаданные и свойства, доступные в схеме для заданной области поиска.

API запросов модели временных рядов (TSM-Q)

Большинство этих API поддерживают операцию пакетного выполнения для включения операций пакетной обработки команд CRUD в нескольких сущностях модели временных рядов:

  • Model Settings API. Позволяет ПОЛУЧИТЬ и ИСПРАВИТЬ тип по умолчанию и имя модели среды.
  • API типов. Позволяет выполнять операции CRUD с типами временных рядов и связанными с ними переменными.
  • API иерархий. Позволяет выполнять операции CRUD в иерархиях временных рядов и со связанными с ними переменными.
  • API экземпляров. Позволяет выполнять операции CRUD с экземплярами временных рядов и связанными с ними полями экземпляров. Кроме того, API экземпляров поддерживает следующие операции:
    • Поиск. Получает частичный список результатов поиска экземпляров временных рядов по атрибутам экземпляра.
    • Предложение. Получает частичный список результатов поиска и предложений экземпляров временных рядов по атрибутам экземпляра.

API запросов временных рядов (TSQ)

Эти интерфейсы API доступны в обоих хранилищах (горячем и холодном) в решении для многоуровневой системы хранения данных.

  • API получения событий. Позволяет выполнять запросы, получать необработанные события и связанные с ними метки времени, так как они записываются в службу "Аналитика временных рядов" 2-го поколения от исходного поставщика. Этот API позволяет получать необработанные события для заданного идентификатора временного ряда и диапазона поиска. Этот API поддерживает разбивку на страницы для получения полного набора данных ответа для выбранного входа.

    Внимание

    В составе предстоящих изменений в правилах обработки и преобразования JSON массивы будут храниться как динамические типы. Свойства полезных данных, хранящиеся в этом типе, доступны ТОЛЬКО через API получения событий.

  • API получения рядов. Позволяет выполнять запросы, получать вычисляемые значения и связанные метки времени событий, применяя вычисления, определенные переменными для необработанных событий. Эти переменные могут определяться либо в модели временных рядов, либо в строке запроса. Этот API поддерживает разбивку на страницы для получения полного набора данных ответа для выбранного входа.

  • API агрегирования рядов. Позволяет выполнять запросы, получать агрегированные значения и связанные метки времени интервалов, применяя вычисления, определенные переменными для необработанных событий. Эти переменные могут определяться либо в модели временных рядов, либо в строке запроса. Этот API поддерживает разбивку на страницы для получения полного набора данных ответа для выбранного входа.

    Для указанного диапазона поиска и интервала этот API возвращает агрегированный ответ для каждого интервала на каждую переменную для идентификатора временного ряда. Количество интервалов в наборе данных ответа вычисляется путем подсчета количества тактов от начала эпохи (число миллисекунд, истекших с момента начала эпохи UNIX — 1 января 1970 г.) и деления количества тактов на размер интервала, указанного в запросе.

    Метки времени, возвращаемые в наборе ответов, имеют левые границы интервала, а не выбранные события из интервала.

Выбор типа магазина

Указанные выше интерфейсы API могут выполняться только для одного из двух типов хранения (холодного или теплого) в одном вызове. Параметры URL-адреса запроса используются для указания типа хранилища, в котором должен выполняться запрос.

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

Обозреватель Аналитики временных рядов Azure и соединитель Power BI выполняют вызовы к приведенным выше интерфейсам API и будут автоматически выбирать правильный параметр storeType, если применимо.

Следующие шаги