更新时间:2022-02-24 GMT+08:00

查询设备影子历史数据

典型场景

第三方应用通过“修改设备影子”接口修改设备影子的配置时,物联网平台会保存修改记录。当第三方应用需要查看设备影子的历史配置记录时,可调用此接口查询获取。

接口功能

支持第三方应用根据设备ID,在物联网平台查询指定设备影子的历史配置数据。

接口描述

1
QueryDeviceDesiredHistoryOutDTO queryDeviceDesiredHistory(QueryDeviceDesiredHistoryInDTO qddhInDTO, String accessToken) throws NorthApiException

参数说明

参数

必选/可选

类型

位置

描述

qddhInDTO

必选

QueryDeviceDesiredHistoryInDTO

query

见下表QueryDeviceDesiredHistoryInDTO的描述。

accessToken

必选

String

header

如果调用了定时刷新token接口,此参数值可以填写null,否则要填写鉴权接口获取的accessToken。

QueryDeviceDesiredHistoryInDTO

参数

必选/可选

类型

位置

描述

appId

必选

String

query

如果是本应用的设备,此参数值可以填写null,否则填写授权应用的appId。

deviceId

必选

String

query

设备ID,用于唯一标识一个设备。

gatewayId

必选

String

query

网关ID,用于标识一个网关设备。

serviceId

可选

String

query

设备的服务标识。

property

可选

String

query

服务属性数据。

pageNo

可选

Integer

query

查询的页码。

  • 值为空时查询内容不分页
  • 值大于等于0的整数时分页查询
  • 值等于0时查询第一页

pageSize

可选

Integer

query

查询每页信息的数量, 缺省值:1。

startTime

可选

String

query

查询产生时间在startTime之后的历史数据。时间格式:yyyyMMdd'T'HHmmss'Z',如 20151212T121212Z。

endTime

可选

String

query

查询产生时间在endTime之前的历史数据。时间格式:yyyyMMdd'T'HHmmss'Z',如 20151212T121212Z。

响应参数

QueryDeviceDesiredHistoryOutDTO

参数

类型

描述

totalCount

Long

查询的记录数量。

pageNo

Long

查询的页码。

pageSize

Long

查询每页信息的数量。

DeviceDesiredHistoryDTO

List<DeviceDesiredHistoryDTO>

设备影子历史配置数据列表,具体参见DeviceDesiredHistoryDTO结构体

DeviceDesiredHistoryDTO结构体说明:

参数

类型

描述

serviceId

String(256)

设备的服务标识。

deviceId

String(256)

设备ID,用于唯一标识一个设备。

gatewayId

String(256)

网关ID,用于标识一个网关设备。当设备是直连设备时,gatewayId与设备的deviceId一致。当设备是非直连设备时,gatewayId为设备所关联的直连设备(即网关)的deviceId。

appId

String(256)

第三方应用的身份标识,用于唯一标识一个应用。

desired

JsonObject

要向设备下发的配置信息。

timestamp

String(256)

数据配置的时间戳,时间格式:yyyyMMdd'T'HHmmss'Z',如 20151212T121212Z。

错误码

Http状态码

错误码

错误描述

说明

200

100203

The application is not existed.

应用不存在。

处理建议:

  • 请检查HTTP请求头域中携带的appId是否有误。
  • 请检查请求路径(url)中传入的appId是否有误。

400

100216

The application input is invalid.

应用输入无效。

处理建议:请参考请求参数说明检查接口请求中的参数是否有误。

400

100419

The deviceId and gatewayId can't be both null.

deviceId和gatewayId不能同时为空。

处理建议:请检查请求参数中deviceId和gatewayId是否填写。

403

100203

The application is not existed.

应用不存在。

处理建议:

  • 请检查HTTP请求头域中携带的appId是否有误。
  • 请检查请求路径(url)中传入的appId是否有误。

403

100217

The application hasn't been authorized.

应用未被授权。

处理建议:若非应用授权场景,请确认请求参数中的appId为空。

403

1010009

app throttle exceed.

应用调用接口过于频繁,超过流控值(默认值是100次/60s)。

处理建议:联系物联网平台维护人员调大流控阈值或者控制接口的调用频率。

403

1010005

App_key or access_token is invalid.

错误的token信息。

处理建议:请检查接口请求中所携带的accessToken是否有误。

500

100203

The application is not existed.

应用不存在。

处理建议:

  • 请检查HTTP请求头域中携带的appId是否有误。
  • 请检查请求路径(url)中传入的appId是否有误。

500

50252

Internal server error.

服务器运行内部错误。

处理建议:物联网平台内部错误,请联系物联网平台维护人员处理。