注意
时序见解服务将于 2024 年 7 月 7 日停用。 请考虑尽快将现有环境迁移到备用解决方案。 有关弃用和迁移的详细信息,请访问我们的 文档。
Azure 时序见解 Gen2 允许通过公共图面 API 查询环境中存储的事件和元数据。 这些 API 也被 Azure 时序见解 TSI 浏览器 使用。
Azure 时序见解第 2 代中提供了三个主要 API 类别:
- 环境 API:这些 API 支持对 Azure 时序见解第 2 代环境本身进行查询。 这些可用于收集调用方有权访问的环境列表和环境元数据。
- 时序 Model-Query(TSM-Q)API功能:启用对环境中时序模型中存储的元数据进行创建、读取、更新和删除(CRUD)操作。 这些可用于访问和编辑实例、类型和层次结构。
- 时序查询 (TSQ) API:使能够从源提供程序检索记录的遥测或事件数据,并使用高级标量和聚合函数对数据进行高效的计算和聚合操作。
Azure 时序见解 Gen2 使用丰富的基于字符串的表达式语言( 时序表达式 (TSX)来表达 时序变量中的计算。
Azure 时序数据洞察 Gen2 API 概述
支持以下核心 API。
环境 API (应用程序接口)
- 获取环境 API:返回调用方有权访问的环境列表。
-
获取环境可用性 API:返回事件时间戳
$ts
的事件计数分布。 此 API 可以帮助确定环境中是否存在任何事件,并返回事件数量的分布情况,这些事件数量如果存在,则按照时间间隔排列。 - 获取事件架构 API:返回给定搜索范围的事件架构元数据。 此 API 有助于检索给定搜索范围架构中可用的所有元数据和属性。
时序 Model-Query(TSM-Q)API
其中大多数 API 支持批处理执行操作,以对多个时序模型实体启用批处理 CRUD 操作:
- 模型设置 API:在环境的默认类型和模型名称上启用 GET 和 PATCH 。
- 类型 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 参数(相关)。
后续步骤
- 详细了解可在 时序模型中定义的不同变量。
- 了解更多关于如何从 Azure Time Series Insights Explorer 查询数据。