- 产品介绍
- 价格说明
- 快速入门
- 开发指南
- 用户指南
- 最佳实践
- API参考
-
SDK参考
- SDK介绍(联通用户专用)
- 应用侧JAVA SDK API参考(联通用户专用)
- 应用侧Python SDK API参考(联通用户专用)
- 设备侧Agent Lite API参考(C)(联通用户专用)
- 设备侧Agent Lite API参考(Android)(联通用户专用)
- 设备侧Agent Lite API参考(Java)(联通用户专用)
-
常见问题
- 热门问题(联通用户专用)
-
方案咨询(联通用户专用)
- 开发中心、设备接入和设备管理的差异是什么?
- IAM子用户或子项目是否可以开通物联网平台服务?
- 物联网平台支持在华为云的哪些区域开通?
- 如何成为华为IoT生态合作伙伴?
- 物联网平台支持哪些接入方式和协议?
- 华为是否提供模组/硬件终端/应用软件等?
- 设备接入模拟器HubSimulator是否能在设备管理使用?
- 设备接入服务如何获取设备数据?
- 物联网平台的应用和设备可以无限创建吗?
- 物联网平台支持批量注册设备吗?
- 物联网平台对应用和设备有消息流控吗?
- 开发中心单个应用允许接入设备数是多少?
- 数据在物联网平台的保存时间是多久?
- 物联网平台支持的DTLS加密算法有哪些?
- 物联网平台支持二进制大小端模式切换吗?
- 什么是NB-IoT?
- 物联网平台支持的硬件架构和使用的相关组件有哪些?
-
设备集成(联通用户专用)
- 如何获取设备和应用对接地址?
- 如何下载LiteOS IDE/IoT Studio?
- 物联网平台允许一个IMEI号注册多个设备吗?
- 如何设置设备名称?
- IoT设备如何激活?
- 物联网平台如何切换设备的在线/离线状态?
- 通过网关接入的子设备,平台如何识别是哪一个设备?
- deviceId、nodeId和IMEI有什么对应关系?
- Agent Lite和Agent Tiny有什么区别?
- 使用Agent Lite接入的网关设备gwbindinfo.json文件丢失如何处理?
- 运行Agent Lite Java Demo报UnsatisfiedLinkError错误怎么处理?
- 设备如何发送文件至物联网平台?
- 开发中心模拟设备如何上报负数?
- 开发中心支持哪几种省电模式?
- 开发中心支持数据转发吗?
- 开发中心没有设备分组和批量添加设备,怎么办?
- 如何检测NB网络信号?
- NB模组附着网络失败如何处理?
- NB模组绑定设备失败怎么办?
- NB模组无法正常上报数据怎么办?
- NB设备上报数据为字符串时如何转换为二进制编码?
- NB设备接入时,出现513错误?
- 为什么执行AT+CUFN=1会返回error?
- 平台向NB-IoT设备缓存下发命令,为什么设备一直收到同一条控制命令?
- AT+CGDCONT=1, CTNB是什么?
- NB-IoT设备如何选择PSM、DRX、eDRX模式?
- 应用集成(联通用户专用)
-
订阅推送(联通用户专用)
- 调用订阅接口时,回调地址如何获取?
- 应用服务器如何收到命令状态变化的通知?
- 如何获取证书?
- 回调地址可以使用域名吗?
- 订阅后消息推送失败,例如提示503如何处理?
- 应用服务器收到数据,但是平台显示推送失败?
- 应用服务器只有内网地址,能否订阅成功?
- 调用订阅接口时,提示回调地址不合法?
- 物联网平台只支持HTTPS的回调地址吗?
- 回调地址可以修改吗?
- 推送证书失效怎么处理?
- 调用删除单个订阅接口时,subscriptionId如何获取?
- 设备数据变化通知和批量设备数据变化通知的区别是什么?
- 应用服务器如何获取物联网平台推送消息时使用的地址?
- 物联网平台订阅推送是否具有重推机制?
- 为什么设备上报一条数据后应用服务器会收到多条推送?
- 在同一个应用下,平台可以将不同设备上报的数据,推送到两个服务器吗?
- NB-IoT设备已订阅消息确认和命令响应通知,为何应用服务器收不到推送消息?
- 数据上报(联通用户专用)
- 命令下发(联通用户专用)
- 产品模型/Profile(联通用户专用)
- 编解码插件(联通用户专用)
- 软/固件升级(联通用户专用)
- 文档下载
- 通用参考
链接复制成功!
创建设备命令
典型场景
设备Profile文件中定义了物联网平台可向设备下发的命令,第三方应用可调用此接口向设备下发命令,配置或修改设备的服务属性,以实现对设备的控制。
物联网平台有两种命令下发机制:
- 立即下发:平台收到命令后立即下发给设备,保证实时性,不保证串行性。
- 缓存下发:平台收到命令后缓存起来,在设备可达时排队串行下发,平台收到前一个命令的响应(模组自动回复的ACK)才会下发后一个命令,保证串行性,不保证实时性。
此接口适用于使用LWM2M/CoAP协议接入的设备,例如NB-IoT设备。
接口功能
支持第三方应用向LWM2M/CoAP设备下发命令,实现对设备的控制。支持物联网平台立即下发命令和缓存下发命令。
接口描述
1 |
def postDeviceCommand(self, pdcInDTO, appId, accessToken) |
参数说明
参数 |
必选/可选 |
类型 |
位置 |
描述 |
---|---|---|---|---|
pdcInDTO |
必选 |
PostDeviceCommandInDTO |
body |
见下表PostDeviceCommandInDTO的描述。 |
appId |
可选 |
String |
query |
如果是本应用的设备,此参数值可以填写None,否则填写授权应用的appId。 |
accessToken |
必选 |
String |
header |
填写鉴权接口获取的accessToken。 |
PostDeviceCommandInDTO
参数 |
必选/可选 |
类型 |
位置 |
描述 |
---|---|---|---|---|
deviceId |
必选 |
String(64) |
body |
下发命令的设备ID,用于唯一标识一个设备。 |
command |
必选 |
CommandDTOV4 |
body |
下发命令的信息,具体参见CommandDTOV4结构体。 |
callbackUrl |
可选 |
String(1024) |
body |
命令状态变化通知地址,当命令状态变化时(执行失败,执行成功,超时,发送,已送达)会通知第三方应用。 |
expireTime |
可选 |
Integer(>=0) |
body |
下发命令的有效时间,单位为秒,表示设备命令在创建后expireTime秒内有效,超过这个时间范围后命令将不再下发,如果未设置则默认为48小时(86400s*2)。 如果expireTime设置为0,则无论物联网平台上设置的命令下发模式是什么,该命令都会立即下发给设备(如果设备处于休眠状态或者链路已老化,则设备收不到命令,平台没收到设备的响应,该命令最终会超时)。 |
maxRetransmit |
可选 |
Integer(0~3) |
body |
命令下发最大重传次数。 |
参数 |
必选/可选 |
类型 |
位置 |
描述 |
---|---|---|---|---|
serviceId |
必选 |
String(1-64) |
body |
命令对应的服务ID,用于标识一个服务。要与profile中定义的serviceId保持一致。 |
method |
必选 |
String(1-128) |
body |
命令服务下具体的命令名称,服务属性等。要与profile中定义的命令名保持一致。 |
paras |
必选 |
ObjectNode |
body |
命令参数,jsonString格式,里面是一个个健值对,每个健都是profile中命令的参数名(paraName),具体格式需要应用和设备约定。 若profile中命令未定义参数,则paras值中的参数可不填写,即设置为"paras": {}。 |
响应参数
PostDeviceCommandOutDTO
参数 |
类型 |
描述 |
---|---|---|
commandId |
String(1-64) |
设备命令ID。 |
appId |
String(1-64) |
第三方应用的身份标识,用于唯一标识一个应用。开发者可通过该标识来指定哪个应用来调用物联网平台的开放API。 |
deviceId |
String(1-64) |
下发命令的设备ID,用于唯一标识一个设备。 |
command |
CommandDTOV4 |
下发命令的信息,具体参见CommandDTOV4结构体。 |
callbackUrl |
String(1024) |
令状态变化通知地址,当命令状态变化时(执行失败,执行成功,超时,发送,已送达)会通知第三方应用。 |
expireTime |
Integer(>=0) |
下发命令的超时时间,单位为秒,表示设备命令在创建后expireTime秒内有效,超过这个时间范围后命令将不再下发,如果未设置则默认为48小时(86400s*2)。 |
status |
String |
下发命令的状态。
|
result |
ObjectNode |
下发命令执行的详细结果。 |
creationTime |
String(20) |
命令的创建时间。 |
executeTime |
String(20) |
命令执行的时间。 |
platformIssuedTime |
String(20) |
平台发送命令的时间。 |
deliveredTime |
String(20) |
平台将命令送达到设备的时间。 |
issuedTimes |
Integer(>=0) |
平台发送命令的次数。 |
maxRetransmit |
Integer(0~3) |
命令下发最大重传次数。 |
错误码
Http状态码 |
错误码 |
错误描述 |
说明 |
---|---|---|---|
200 |
100203 |
The application is not existed. |
应用不存在。 处理建议:
|
200 |
100217 |
The application hasn't been authorized. |
应用未被授权。 处理建议:若非应用授权场景,请确认请求参数中的appId为空。 |
200 |
100418 |
The deviceData is not existed. |
设备信息不存在。 处理建议:
|
200 |
100428 |
The device is not online. |
设备不在线。 处理建议:请检查设备与物联网平台的连接是否正常。 |
200 |
100431 |
The serviceType is not exist. |
服务类型不存在。 处理建议:
|
400 |
100022 |
The input is invalid. |
输入参数无效。 处理建议:请检查接口调用请求中携带参数的合法性。 |
400 |
100223 |
Command counts has reached the upLimit. |
缓存的命令数已到达限制。处于PENDING状态的命令条数不超过限定值。默认限定值为20。 处理建议:如当前平台缓存的命令还需执行,请让设备上报数据触发缓存命令的下发;如当前平台缓存的命令有不需要执行的命令,请调用“修改设备命令V4”接口,将命令的状态从PENDING修改未CANCELED。 |
403 |
100217 |
The application hasn't been authorized. |
应用未被授权。 处理建议:若非应用授权场景,请确认请求参数中的appId为空。 |
403 |
100612 |
Device is zombie. |
设备为僵尸设备。(距离设备上次上线时间超过阈值,默认7天) 处理建议:请把设备上线后再重新下发命令。 |
403 |
1010009 |
app throttle exceed. |
应用调用接口过于频繁,超过流控值(默认值是100次/60s)。 处理建议:联系物联网平台维护人员调大流控阈值或者控制接口的调用频率。 |
403 |
1010005 |
Invalid access token or appId. |
错误的token信息。 处理建议:请检查接口请求中所携带的accessToken是否有误。 |
500 |
100001 |
Internal server error. |
服务内部处理错误。 处理建议:物联网平台内部错误,请联系物联网平台维护人员处理。 |
500 |
100023 |
The data in dataBase is abnomal. |
数据库异常。 处理建议:物联网平台内部错误,请联系物联网平台维护人员处理。 |
500 |
100220 |
Get AppKey from header failed. |
获取appKey失败。 处理建议 : 请检查接口请求的header中是否携带appId。 |
500 |
101016 |
Get iotws address failed. |
获取iotws地址失败。 处理建议:物联网平台内部错误,请联系物联网平台维护人员处理。 |
500 |
101017 |
Get newCallbackUrl from oss failed. |
从oss获取新的回调地址失败。 处理建议:物联网平台内部错误,请联系物联网平台维护人员处理。 |
503 |
100501 |
Congestion occurs, and the current network has been flow-controlled |
发生拥塞,当前的网络已经被流控。 处理建议:请稍后重新再尝试下发命令。 |