跳转至主要内容
CloudStudio

获取多个端点的最新数据

此服务可以查询最新记录的数据,最多可同时查询 5 个设备,且只需一次调用。

主要建议在需要同时显示多个传感器的实时信息时使用,这样无需为每个传感器单独调用,从而节省时间并减少网络流量。

要使用此功能,请使用 GET 方法通过特定地址调用 API。

GET /api/v2/endpointData/multiple

出于安全考虑,需要提供用于识别请求用户的访问密钥。该密钥即访问令牌,且必须作为地址的一部分提供。

GET https://gear-dev.cloud.studio/api/v2/endpointData/multiple?accessToken=123456789-1110-0022-3333-987654321012&endpointIds=351031,151040,252340,511088,720510

如果访问密钥缺失或无效,API 将返回 500 错误,错误代码 8001 位于 FaultCode 字段中。响应格式请参阅错误一节。

必需的参数如下:

  • 访问密钥(Access Token):用于识别授权用户的密钥。
  • 类型为 String,必填。
  • EndpointsIDs:要获取数据的设备传感器 ID,以逗号分隔。
  • 类型为 List,必填。
  • 注意:每次调用的端点上限为 5(五)个。

如果请求中发送的 endpointIds 超过 5 个,API 将返回 500 错误,错误代码 100004 位于 FaultCode 字段中,表示已超出端点数量上限。请参阅错误一节。

请求正确发出后,将收到一个对象列表(JSON)。列表中的每个对象代表所请求的一个传感器的信息。

JSON 响应,列出每个端点的描述、序列号、UTC 时间戳和值

列表中的信息如下:

  • EndpointID:所查询传感器的标识号
  • Description:所查询传感器的名称
  • SequenceNumber:表示数据记录顺序的序列号(可用于跟踪/历史记录)
  • TimeStamp_UTC:lastValue 记录的确切日期和时间
  • Value:传感器上报的最新值

如果某个端点没有数据,则 Value 和 timeStamp 字段的值将为 null。

注意:新增此功能会影响所有端点数据查询方法,因为这些方法现在都包含 description 字段。

Camera 端点除外。

最后更新于