从 Azure 时序洞察第二代查询数据

注意

时序见解服务将于 2024 年 7 月 7 日停用。 请考虑尽快将现有环境迁移到备用解决方案。 有关弃用和迁移的更多信息,请访问我们的 文档

Azure 时序见解 Gen2 允许通过公共图面 API 查询环境中存储的事件和元数据。 这些 API 也被 Azure 时序见解 TSI 浏览器使用。

Azure 时序见解第 2 代中提供了三个主要 API 类别:

  • 环境 API:这些 API 允许对 Azure Time Series Insights Gen2 环境的查询。 这些可用于收集调用方有权访问的环境列表和环境元数据。
  • 时序模型 Model-Query(TSM-Q)API:启用对环境中时序模型中存储元数据的创建、读取、更新和删除(CRUD)操作。 这些可用于访问和编辑实例、类型和层次结构。
  • 时序查询(TSQ)API:支持实时从源提供程序记录的遥测或事件数据的检索,并使用高级标量和聚合函数对数据进行高效计算和聚合。

Azure 时序见解第 2 代使用丰富的字符串表达语言(时序表达式(TSX)),用于在 时序变量中进行计算。

Azure 时序数据洞察 Gen2 API 概述

支持以下核心 API。

时序查询概述

环境 API (应用程序接口)

  • 获取环境 API:返回调用方有权访问的环境列表。
  • 获取环境可用性 API:返回事件时间戳 $ts的事件计数分布。 此 API 可以帮助确定环境中是否存在任何事件,并返回事件数量的分布情况,这些事件数量如果存在,则按照时间间隔排列。
  • 获取事件架构 API:返回给定搜索范围的事件架构元数据。 此 API 有助于检索给定搜索范围架构中可用的所有元数据和属性。

时序 Model-Query(TSM-Q)API

其中大多数 API 支持批处理执行操作,以对多个时序模型实体启用批处理 CRUD 操作:

  • 模型设置 API:在默认类型和环境模型名称上启用 GETPATCH
  • 类型 API:支持在时序类型及其相关变量上实现 CRUD 操作。
  • 层次结构 API:在时序层次结构及其关联的字段路径上启用 CRUD。
  • 实例 API:在时序实例及其关联的实例字段中启用 CRUD。 此外,实例 API 还支持以下操作:
    • 搜索:检索基于实例属性的时序实例的部分匹配结果列表。
    • 建议:搜索并建议基于实例属性搜索时序实例的部分命中列表。

时序查询(TSQ) API

这些 API 可用于我们的多层存储解决方案中的两个存储层(热层和冷层)。

  • 获取事件 API:允许查询和检索从源提供商在 Azure 时序见解 Gen2 中记录的原始事件及其关联的事件时间戳。 此 API 允许检索给定时序 ID 和搜索范围的原始事件。 此 API 支持分页来检索所选输入的完整响应数据集。

    重要

    作为即将对 JSON 平展和转义规则更改的一部分,数组将被存储为 动态 类型。 存储为此类型的有效负载属性 只能通过 Get Events API访问。

  • 获取系列 API:通过对原始事件应用变量定义的计算,启用对计算值和关联的事件时间戳的查询和检索。 可以在时序模型中定义这些变量,也可以在查询中内联提供。 此 API 支持分页来检索所选输入的完整响应数据集。

  • 汇总系列 API:允许通过对原始事件应用变量定义的计算,实现对汇总值及其相关周期时间戳的查询和检索。 可以在时序模型中定义这些变量,也可以在查询中内联提供。 此 API 支持分页来检索所选输入的完整响应数据集。

    对于指定的搜索范围和间隔,此 API 针对每个时间序列 ID 返回每个时间间隔和每个变量的聚合响应。 响应数据集中的间隔数通过计算纪元刻度(自 Unix epoch - 1970 年 1 月 1 日起经过的毫秒数)计算,并将刻度除以查询中指定的间隔范围大小。

    响应集中返回的时间戳是区间左边界,而非区间内采样的事件。

选择应用商店类型

上述 API 只能在单个调用中针对两种存储类型之一(冷或暖)执行。 查询 URL 参数用于指定查询应执行的 存储类型

如果未指定任何参数,则默认情况下将在冷存储上执行查询。 如果查询跨越时间范围重叠冷存储和暖存储,建议将查询路由到冷存储,以获得最佳体验,因为暖存储将仅包含部分数据。

Azure 时序见解浏览器Power BI 连接器 调用上述 API,并在相关情况下自动选择正确的 storeType 参数。

后续步骤