• 沒有找到結果。

查询设备命令撤销任务

DeviceCommandRespV4结构体。

4.3.8.5 查询设备命令撤销任务

典型场景

第三方应用创建了设备命令撤销任务后,可调用此接口查询设备命令撤销任务的详细 信息和执行状态,以了解撤销任务的执行情况。

接口功能

支持第三方应用在物联网平台查询设备命令撤销任务信息和状态,可指定条件查询单 个或多个撤销任务。

接口描述

def queryDeviceCmdCancelTask(self, qdcctInDTO, accessToken)

参数说明

参数 必选/可

类型 位置 描述

qdcctInDT

O 必选 QueryDevic eCmdCance

pageNo 可选 Integer(>=

0) query 查询的页码,大于等于0,默认值:

“0”。

pageSize 可选 Integer(>=

1&&<=100 0)

query 查询每页信息的数量,大于等于1,

最大值1000,默认值:“1000”。

taskId 可选 String query 撤销任务的任务ID。

deviceId 可选 String query 执行设备命令撤销任务的设备ID。

status 可选 String query 设备命令撤销任务的状态。

startTim

endTime 可选 String query 查询结束时间,查询创建撤销设备命 令任务时间在endTime之前的记录。

时间格式:

yyyyMMdd'T'HHmmss'Z',如

“20151212T121212Z”。

appId 可选 String query 如果是本应用的设备命令,此参数值 可以填写None,否则填写授权应用 的appId。

响应参数

QueryDeviceCmdCancelTaskOutDTO

参数 类型 描述 paginatio

n Pagination 页码信息,具体参见Pagination结构体。

data List<DeviceComm andCancelTaskRes pV4>

设备命令列表,具体参见

DeviceCommandCancelTaskRespV4结构体。

Pagination结构体说明:

参数 类型 描述

pageNo long 查询结果页码。

pageSize long 每页信息数量。

totalSize long 记录总数,即查询到的撤销任务中的命令总 数。

DeviceCommandCancelTaskRespV4结构体说明:

参数 类型 描述

taskId String(1-64) 设备命令撤销任务的任务ID。

appId String(1-64) 设备命令撤销任务所属的应用ID。

deviceId String(1-64) 设备命令撤销任务指定撤销命令的设备ID。

status String 撤销任务的任务状态。

● “WAITTING”表示等待执行中

● “RUNNING”表示撤销任务正在执行

● “SUCCESS”表示撤销任务执行成功

● “FAILED”表示撤销任务执行失败

● “PART_SUCCESS”表示撤销任务部分执行成 功。

totalCoun

t Integer 撤销的设备命令总数。

deviceCo

mmands List<DeviceComm

andRespV4> 设备命令撤销任务信息列表,具体参见

DeviceCommandRespV4结构体。

DeviceCommandRespV4结构体说明:

参数 类型 描述

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 下发命令的状态。

● “DEFAULT”表示未下发

● “EXPIRED”表示命令已经过期

● “SUCCESSFUL”表示命令已经成功执行

● “FAILED”表示命令执行失败

● “TIMEOUT”表示命令下发执行超时

● “CANCELED”表示命令已经被撤销执行 result ObjectNode 下发命令执行的详细结果。

creationTime String(20) 命令的创建时间。

executeTime String(20) 命令执行的时间。

platformIssue

dTime String(20) 平台发送命令的时间。

deliveredTime String(20) 平台将命令送达到设备的时间。

issuedTimes Integer(>=0) 平台发送命令的次数。

maxRetransmi

t Integer(0~3) 命令下发最大重传次数。

CommandDTOV4结构体说明:

参数 必选/可选 类型 描述

serviceId 必选 String(1-64) 命令对应的服务ID,用于标识一个服务。

参数 必选/可选 类型 描述 method 必选 String(1-128

) 命令服务下具体的命令名称,服务属性

等。

paras 可选 Object 命令参数的jsonString,具体格式需要应 用和设备约定。

错误码

Http状 态码

错误码 错误描述 说明

200 10020

3 The application is

not existed. 应用不存在。

处理建议:

● 请检查HTTP请求头域中携带的appId是 否有误。

● 请检查请求路径(url)中传入的appId 是否有误。

200 10021

7 The application hasn't been authorized.

应用未被授权。

处理建议:若非应用授权场景,请确认请 求参数中的appId为空。

200 10041

8 The deviceData is

not existed. 设备信息不存在。

处理建议:

● 请求参数中携带的deviceId错误。请确 认该deviceId是否属于该appId或者 deviceId是否写错。

● Header中携带的appId有误,请确认该 appId下是否有该deviceId。

● 如果URL中携带了可选参数appId,请 检查该appId是否有误。

400 10002

2 The input is

invalid. 输入参数无效。

处理建议:请检查接口调用请求中携带参 数的合法性。

403 10020

3 The application is

not existed. 应用不存在。

处理建议:

● 请检查HTTP请求头域中携带的appId是 否有误。

● 请检查请求路径(url)中传入的appId 是否有误。

403 10021

7 The application

hasn't been 应用未被授权。

Http状 态码

错误码 错误描述 说明

403 10100

09 app throttle

exceed. 应用调用接口过于频繁,超过流控值(默 认值是100次/60s)。

处理建议:联系物联网平台维护人员调大 流控阈值或者控制接口的调用频率。

403 10100

05 Invalid access

token or appId. 错误的token信息。

处理建议:请检查接口请求中所携带的 accessToken是否有误。

500 10000

1 Internal server

error. 服务内部处理错误。

处理建议:物联网平台内部错误,请联系 物联网平台维护人员处理。

500 10022

0 Get AppKey from

header failed. 获取appKey失败。

处理建议 : 请检查接口请求的header中是 否携带appId。

503 10050

1 Congestion occurs, and the current network has been flow-controlled

发生拥塞,当前的网络已经被流控。

4.3.8.6 设备服务调用