本文导读

展开导读

文档首页/ IoT物联网/ API参考/ 北向PHP SDK API参考/ 业务接口列表/ 命令下发（NB命令）/ 查询设备命令

查询设备命令

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

查看PDF

典型场景

第三方应用向设备下发命令后，可调用此接口在物联网平台查询下发命令的状态及内容信息，以了解命令的执行情况。

接口功能

支持第三方应用在物联网平台查询下发命令的状态和内容信息，可查询指定时间段内本应用下的所有下发命令，或者指定设备的所有下发命令。

接口描述

1	public function queryDeviceCommand($qdcInDTO, $accessToken)

参数说明

参数	必选/可选	位置	描述
$qdcInDTO	必选	query	见下表QueryDeviceCommandInDTO的描述。
$accessToken	必选	header	填写鉴权接口获取的accessToken。

QueryDeviceCommandInDTO

参数	必选/可选	位置	描述
$pageNo	可选	query	查询的页码，大于等于0，默认值：“0”。
$pageSize	可选	query	查询每页信息的数量，大于等于1，最大值1000，默认值：“1000”。
$deviceId	可选	query	指定查询命令的设备ID。
$startTime	可选	query	查询开始时间，查询下发命令时间在startTime之后的记录。时间格式：yyyyMMdd'T'HHmmss'Z'，如 “20151212T121212Z”。
$endTime	可选	query	查询结束时间，查询下发命令时间在endTime之前的记录。时间格式：yyyyMMdd'T'HHmmss'Z'，如 “20151212T121212Z”。
$appId	可选	query	如果是本应用的设备命令，此参数值可以填写null，否则填写授权应用的appId。

响应参数

QueryDeviceCommandOutDTO

参数	描述
$pagination	页面信息，具体参见Pagination结构体。
$data	设备命令列表，具体参见DeviceCommandRespV4结构体。

Pagination结构体说明：

参数	描述
$pageNo	页码。
$pageSize	每页信息数量。
$totalSize	记录总数。

DeviceCommandRespV4结构体说明：

参数	描述
$commandId	设备命令ID。
$appId	第三方应用的身份标识，用于唯一标识一个应用。开发者可通过该标识来指定哪个应用来调用物联网平台的开放API。
$deviceId	下发命令的设备ID，用于唯一标识一个设备。
$command	下发命令的信息，具体参见CommandDTOV4结构体。
$callbackUrl	令状态变化通知地址，当命令状态变化时（执行失败，执行成功，超时，发送，已送达）会通知第三方应用。
$expireTime	下发命令的超时时间，单位为秒，表示设备命令在创建后expireTime秒内有效，超过这个时间范围后命令将不再下发，如果未设置则默认为48小时（86400s*2）。
$status	下发命令的状态。 “DEFAULT”表示未下发 “EXPIRED”表示命令已经过期 “SUCCESSFUL”表示命令已经成功执行 “FAILED”表示命令执行失败 “TIMEOUT”表示命令下发执行超时 “CANCELED”表示命令已经被撤销执行
$result	下发命令执行的详细结果。
$creationTime	命令的创建时间。
$executeTime	命令执行的时间。
$platformIssuedTime	平台发送命令的时间。
$deliveredTime	平台将命令送达到设备的时间。
$issuedTimes	平台发送命令的次数。
$maxRetransmit	命令下发最大重传次数。

CommandDTOV4结构体说明：

参数	必选/可选	描述
$serviceId	必选	命令对应的服务ID，用于标识一个服务。
$method	必选	命令服务下具体的命令名称，服务属性等。
$paras	可选	命令参数的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文件中是否存在。
400	100022	The input is invalid.	输入参数无效。处理建议：请确认startTime和endTime都不为空，且endTime比startTime晚。请确认pageNo不为空，且pageNo大于0。请检查pageSize不为空，且pageSize大于1。
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	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

直接提交取消