错误码
4.3.4.7 修改设备影子
典型场景
物联网平台支持创建设备的“影子”。设备影子用于存储设备最新上报的服务属性数 据,以及第三方应用对服务属性的配置(服务属性为设备Profile文件中定义的service 属性)。若设备处于离线或异常状态时,第三方应用无法通过命令下发的方式向设备 下发配置,此时可把要下发的配置设置到设备影子,当设备重新上线时,设备影子会 把配置下发给设备。第三方应用可调用此接口在设备影子上配置要下发给设备的配置 信息。
每个设备有且只有一个设备影子,设备影子上有desired和report区。
● desired区用于存储对设备服务属性的配置。若设备当前在线,desired区的配置会 即时下发给设备;若设备当前不在线,desired区的配置会在设备上线时再下发给 设备。
● report区用于存储设备最新上报的服务属性数据。当设备上报数据时,平台会把数 据同步到设备影子的report区。
接口功能
支持第三方应用配置设备影子desired区的信息,用于设备上线时把配置下发给设备。
接口描述
def modifyDeviceShadow(self, mdsInDTO, deviceId, appId, accessToken)
接口所属类
DeviceManagement
参数说明
参数 必选/可
选
类型 位置 描述
mdsInDT
O 必选 ModifyDevi ceShadowIn DTO
body 见下表
ModifyDeviceShadowInDTO的 描述。
deviceId 必选 String(256) path 设备ID,用于唯一标识一个设 备,在注册设备时由物联网平台 分配获得。
appId 可选 String query 如果是本应用的设备,此参数值 可以填写None,否则填写授权 应用的appId。
accessTok
en 必选 String header 填写鉴权接口获取的 accessToken。
参数 必选/可 选
类型 位置 描述
serviceDe
sireds 必选 List<Service DesiredDTO
serviceId 可选 String(1-25
6) body 服务ID,用于标识一个服务。
desired 可选 Object body 设备的状态。
返回值
200 1004
25 The special deviceCapability is not exist.
设备模板不存在。
处理建议:请检查设备模板是否已在物联 网平台上传。
200 1004
31 The serviceType
is not exist. 服务类型不存在。
处理建议:
● 请检查该设备的Profile文件是否已上传 到物联网平台。
● 请检查请求参数是否正确,或者 serviceId在Profile文件中是否存在。
400 1070
02 The properties is empty in
database.
设备属性不存在。
处理建议:请检查接口请求中的serviceId 是否有误。
400 1070
03 The request properties is unknown.
设备状态为未知。
处理建议:请检查设备与平台的连接是否 正常。
400 5040
0 The input is
invalid. 输入参数无效。
处理建议:请检查接口调用请求中携带参 数的合法性。
Http状态 码
错误 码
错误描述 说明
403 1002
03 The application is
not existed. 应用不存在。
处理建议:
● 请检查HTTP请求头域中携带的appId是 否有误。
● 请检查请求路径(url)中传入的appId 是否有误。
403 1002
17 The application hasn't been authorized.
应用未被授权。
处理建议:若非应用授权场景,请确认请 求参数中的appId为空。
403 1004
43 The property is forbidden to write.
设备属性不可写。
403 1010
009 app throttle
exceed. 应用调用接口过于频繁,超过流控值(默 认值是100次/60s)。
处理建议:联系物联网平台维护人员调大 流控阈值或者控制接口的调用频率。
403 1010
005 pp_key or access_token is invalid.
错误的token信息。
处理建议:请检查接口请求中所携带的 accessToken是否有误。
404 1004
03 The device is not
existed. 设备不存在。
处理建议:物联网平台未找到deviceId对 应的设备,请检查deviceId是否有误。
404 1004
18 The deviceData is
not existed. 设备信息不存在。
处理建议:
● 请求参数中携带的deviceId错误。请确 认该deviceId是否属于该appId或者 deviceId是否写错。
● Header中携带的appId有误,请确认该 appId下是否有该deviceId。
● 如果URL中携带了可选参数appId,请 检查该appId是否有误。
500 1000
23 The data in dataBase is abnomal.
数据库异常。
处理建议:物联网平台内部错误,请联系 物联网平台维护人员处理。
Http状态 码
错误 码
错误描述 说明
500 1002
03 The application is
not existed. 应用不存在。
处理建议:
● 请检查HTTP请求头域中携带的appId是 否有误。
● 请检查请求路径(url)中传入的appId 是否有误。
500 5025
2 Internal server
error. 服务器运行内部错误。
处理建议:物联网平台内部错误,请联系 物联网平台维护人员处理。
4.3.5 数据采集
物联网平台支持第三方应用查询设备的基本信息,同时还支持查看设备上报的历史数 据,能按时、天,月等维度查看设备上报的历史数据。