修改设备命令

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

查看PDF

典型场景

第三方应用向设备下发命令后，如果由于命令排队、设备不在线等原因，物联网平台还未把命令下发给设备执行，此时第三方应用可调用此接口修改该命令的状态信息。当前仅支持把命令状态修改为CANCELED状态，即撤销命令的执行。

接口功能

支持第三方应用修改指定命令的状态信息，仅能修改还处于PENDING状态的命令，且当前仅支持修改的命令状态为CANCELED，即撤销命令。

接口描述

1	UpdateDeviceCommandOutDTO updateDeviceCommand(UpdateDeviceCommandInDTO udcInDTO, String deviceCommandId, String appId, String accessToken) throws NorthApiException

参数说明

参数	必选/可选	类型	位置	描述
udcInDTO	必选	UpdateDeviceCommandInDTO	body	见下表UpdateDeviceCommandInDTO的描述。
deviceCommandId	必选	String	path	要修改的命令ID，在调用创建设备命令接口后获得。
appId	必选	String	query	如果是本应用的设备命令，此参数值可以填写null，否则填写授权应用的appId。
accessToken	必选	String	header	如果调用了定时刷新token接口，此参数值可以填写null，否则要填写鉴权接口获取的accessToken。

UpdateDeviceCommandInDTO

参数	必选/可选	类型	描述
status	必选	String	命令执行结果，可选值：CANCELED，撤销命令。

响应参数

UpdateDeviceCommandOutDTO

参数	类型	描述
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	下发命令的状态。 PENDING表示未下发 EXPIRED表示命令已经过期 SUCCESSFUL表示命令已经成功执行 FAILED表示命令执行失败 TIMEOUT表示命令下发执行超时 CANCELED表示命令已经被撤销执行 DELIVERED表示命令已送达设备 SENT表示命令正在下发中
result	ObjectNode	下发命令执行的详细结果。
creationTime	String(20)	命令的创建时间。
executeTime	String(20)	命令执行的时间。
platformIssuedTime	String(20)	平台发送命令的时间。
deliveredTime	String(20)	平台将命令送达到设备的时间。
issuedTimes	Integer(>=0)	平台发送命令的次数。
maxRetransmit	Integer(0~3)	命令下发最大重传次数。

CommandDTOV4结构体说明：

参数	必选/可选	类型	位置	描述
serviceId	必选	String(1-64)	body	命令对应的服务ID，用于标识一个服务。
method	必选	String(1-128)	body	命令服务下具体的命令名称，服务属性等。
paras	可选	Object	body	命令参数的jsonString，具体格式需要应用和设备约定。

错误码

Http状态码	错误码	错误描述	说明
200	100203	The application is not existed.	应用不存在。处理建议：请检查HTTP请求头域中携带的appId是否有误。请检查请求路径（url）中传入的appId是否有误。
200	100217	The application hasn't been authorized.	应用未被授权。处理建议：若非应用授权场景，请确认请求参数中的appId为空。
200	100418	The deviceData is not existed.	设备信息不存在。处理建议：请求参数中携带的deviceId错误。请确认该deviceId是否属于该appId或者deviceId是否写错。 Header中携带的appId有误，请确认该appId下是否有该deviceId。如果URL中携带了可选参数appId，请检查该appId是否有误。
200	100428	The device is not online.	设备不在线。处理建议：请检查设备与物联网平台的连接是否正常。
200	100431	The serviceType is not exist.	服务类型不存在。处理建议：请检查该设备的Profile文件是否已上传到物联网平台。请检查请求参数是否正确，或者serviceId在Profile文件中是否存在。
200	100434	The device command is not existed.	设备命令不存在。处理建议：请检查接口请求中的设备命令ID是否正确。
200	100435	The device command already canceled, expired or executed, Cannot cancel.	设备命令已经取消，过期或执行，不能取消。
400	100022	The input is invalid.	输入参数无效。处理建议：请检查接口调用请求中携带参数的合法性。
403	1010009	app throttle exceed.	应用调用接口过于频繁，超过流控值（默认值是100次/60s）。处理建议：联系物联网平台维护人员调大流控阈值或者控制接口的调用频率。
403	1010005	App_key or access_token is invalid.	错误的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	发生拥塞，当前的网络已经被流控。

父主题： 命令下发（NB命令）

上一篇：查询设备命令

下一篇：创建设备命令撤销任务

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消