查询来自 Azure 时序见解第 2 代的数据

注意

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

使用 Azure 时序见解第 2 代可以通过公共 Surface API 对存储在环境中的事件和元数据进行数据查询。

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

  • 环境 API:这些 API 允许查询 Azure 时序见解第 2 代环境本身。 这些 API 可用于收集调用方有权访问的环境列表和环境元数据。
  • 时序模型-查询 (TSM-Q) API:用于针对环境的时序模型中存储的元数据执行创建、读取、更新和删除 (CRUD) 操作。 这些 API 可用于访问和编辑实例、类型与层次结构。
  • 时序查询 (TSQ) API:用于检索从源提供程序记录的遥测数据或事件数据,以及通过高级标量和聚合函数对数据执行高性能计算和聚合。

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

Azure 时序见解第 2 代 API 概述

支持以下核心 API。

时序查询概述

环境 API

  • 获取环境 API:返回调用方有权访问的环境的列表。
  • 获取环境可用性 API:返回事件时间戳 $ts 中事件计数的分布。 此 API 通过返回按时间间隔划分的事件计数(如果有),来帮助确定环境中是否出现了任何事件。
  • 获取事件架构 API:返回给定搜索范围的事件架构元数据。 此 API 可帮助检索给定搜索范围的架构中可用的所有元数据和属性。

时序模型-查询 (TSM-Q) API

其中的大多数 API 支持批量执行操作,可用于对多个时序模型实体执行批量 CRUD 操作:

  • 模型设置 API:允许对环境的默认类型和模型名称执行 GETPATCH 操作。
  • 类型 API:允许对时序类型及其关联变量执行 CRUD。
  • 层次结构 API:允许对时序层次结构及其关联的字段路径执行 CRUD。
  • 实例 API:允许对时序实例及其关联的实例字段执行 CRUD。 另外,实例 API 支持以下操作:
    • 搜索:检索在搜索基于实例属性的时序实例时获得的结果的部分列表。
    • 建议:搜索并建议在搜索基于实例属性的时序实例时获得的结果的部分列表。

时序查询 (TSQ) API

这些 API 对多层存储解决方案中的两种存储(暖存储和冷存储)都可用。

  • 获取事件 API:用于查询和检索原始事件和关联的事件时间戳(当它们从源提供程序记录在 Azure 时序见解第 2 代中时)。 此 API 可用于从给定时序 ID 和搜索范围中检索原始事件。 此 API 支持分页,可以检索选定输入的完整响应数据集。

    重要

    根据 JSON 平展和转义规则即将发生的变化中的说明,数组将会被存储为动态类型。 若要访问存储为这种类型的有效负载属性,只能通过获取事件 API。

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

  • 聚合时序 API:此 API 对原始事件应用变量定义的计算,可用于查询和检索聚合值与关联的间隔时间戳。 这些变量可以在时序模型中定义,或者在查询中以内联方式提供。 此 API 支持分页,可以检索选定输入的完整响应数据集。

    对于指定的搜索范围和间隔,此 API 将根据每个间隔和变量返回时序 ID 的聚合响应。 响应数据集中的间隔数的计算方式是,统计纪元计时周期数(自 Unix 纪元 1970 年 1 月 1 日开始消逝的毫秒数),然后将计时周期数除以查询中指定的间隔跨度大小。

    响应集中返回的时间戳与左间隔边界相关,而与间隔中的采样事件无关。

选择存储类型

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

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

Azure 时序见解资源管理器和 Power BI 连接器对上述 API 发起调用,并将自动选择相关的正确 storeType 参数。

后续步骤