文档首页> 设备管理 IoTDM（联通用户专用）> API参考> 北向API参考> 数据采集> 查询设备影子历史数据
更新时间：2022-02-24 GMT+08:00
查看PDF

查询设备影子历史数据

典型场景

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

接口功能

支持应用服务器根据设备ID，在物联网平台查询指定设备影子的历史配置数据。

接口原型

请求方法

GET

请求地址

https://server:port/iocm/app/shadow/v1.5.0/deviceDesiredHistory?deviceId={deviceId}&gatewayId={gatewayId}&appId={appId}&serviceId={serviceId}&property={property}&pageNo={pageNo}&pageSize={pageSize}&startTime={startTime}&endTime={endTime}

传输协议

HTTPS

请求参数

参数

必选/可选

类型

位置

描述

app_key

必选

String

header

访问物联网平台的应用ID，在物联网平台创建应用时由平台分配获得。

Authorization

必选

String

header

访问物联网平台的认证信息，值为“Bearer {accessToken}”，其中{accessToken}为调用鉴权接口返回的accessToken。

appId

可选

String

query

访问物联网平台的应用ID，在物联网平台创建应用时由平台分配获得。此处填写授权应用的appId。

deviceId

必选

String

query

设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。

gatewayId

必选

String

query

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

serviceId

可选

String

query

设备的服务标识。

property

可选

String

query

服务属性数据。

pageNo

可选

Integer

query

分页查询时指定要查询的页码信息，默认值为0，取值范围为大于等于0的整数，值为0时，查询第一页。

pageSize

可选

Integer

query

分页查询时每页显示的记录数，查询结果根据pageSize进行分页，默认值为25，取值范围为1-250的整数。

startTime

可选

String

query

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

endTime

可选

String

query

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

响应参数

StatusCode: 200 OK

参数

类型

描述

totalCount

Long

查询的记录数量。

pageNo

Long

查询的页码。

pageSize

Long

查询每页信息的数量。

DeviceDesiredHistoryDTO

List<DeviceDesiredHistoryDTO>

设备影子历史配置数据列表。

DeviceDesiredHistoryDTO：

参数

类型

描述

serviceId

String(256)

设备的服务标识。

deviceId

String(256)

设备ID，用于唯一标识一个设备，在注册设备时由物联网平台分配获得。

gatewayId

String(256)

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

appId

String(256)

设备所属的应用ID。

desired

JsonObject

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

timestamp

String(256)

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

请求示例

Method: GET
request:
https://server:port/iocm/app/shadow/v1.5.0/deviceDesiredHistory?deviceId={deviceId}&gatewayId={gatewayId}&appId={appId}&serviceId={serviceId}&property={property}&pageNo={pageNo}&pageSize={pageSize}&startTime={startTime}&endTime={endTime}
Header:
app_key: ******
Authorization: Bearer *****
Content-Type: application/json

响应示例

response:
Status Code: 200 OK
Content-Type: application/json
Body:
{
    "totalCount":"****",
    "pageNo":"*****",
    "pageSize":"*****",
    "DeviceDesiredHistoryDTO":[
        {
            "serviceId":"*****",
            "deviceId":"*****",
            "gatewayId":"*****",
            "appId":"*****",
            "desired":"*****",
            "timestamp":"*****"
        }
    ]
}

错误码

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.

服务器运行内部错误。

处理建议：物联网平台内部错误，请联系物联网平台维护人员处理。
父主题： 数据采集