文档首页 > > API参考> 应用侧API参考(联通用户专用)> 命令下发> 创建设备命令撤销任务

创建设备命令撤销任务

分享
更新时间: 2020/02/14 GMT+08:00

接口说明

应用服务器向设备下发命令后,如果由于命令排队、设备不在线等原因,物联网平台还未把命令下发给设备执行(PENDING状态),此时应用服务器可调用此接口撤销指定设备的所有未下发的命令,对于已下发成功的命令不可撤销。

URI

请求方法

POST

URI

/iocm/app/cmd/v1.4.0/deviceCommandCancelTasks

传输协议

HTTPS

请求参数

参数

必选/可选

类型

位置

描述

app_key

必选

String

header

访问物联网平台的应用ID,在物联网平台创建应用时由平台分配获得。

Authorization

必选

String

header

访问物联网平台的认证信息,值为“Bearer {accessToken}”,其中{accessToken}为调用鉴权接口返回的accessToken。

appId

可选

String

query

命令所属的应用ID,当创建授权应用下的命令撤销任务时才需要填写。

deviceId

必选

String(1-64)

body

待撤销设备命令的设备ID,用于唯一标识一个设备,在注册设备时由物联网平台分配获得。撤销任务将会撤销所有向该设备下发的命令。

响应参数

Status Code: 201 Created

参数

类型

描述

taskId

String(1-64)

设备命令撤销任务的任务ID。

appId

String(1-64)

设备命令撤销任务所属的应用ID。

deviceId

String(1-64)

执行设备命令撤销任务的设备ID,用于唯一标识一个设备,在注册设备时由物联网平台分配获得。

status

String

撤销任务的任务状态。

  • WAITTING表示等待执行中
  • RUNNING表示撤销任务正在执行
  • SUCCESS表示撤销任务执行成功
  • FAILED表示撤销任务执行失败
  • PART_SUCCESS表示撤销任务部分执行成功。

totalCount

Integer

撤销的设备命令总数。

deviceCommands

List<DeviceCommandResp>

撤销的设备命令列表。

DeviceCommandResp:

参数

类型

描述

commandId

String(1-64)

设备命令ID,用于唯一标识一条命令,在下发设备命令时由物联网平台分配获得。

appId

String(1-64)

设备命令撤销任务所属的应用ID。

deviceId

String(1-64)

下发命令的设备ID,用于唯一标识一个设备,在注册设备时由物联网平台分配获得。

command

CommandDTO

下发命令的信息。

callbackUrl

String(1024)

令状态变化通知地址,当命令状态变化时(执行失败,执行成功,超时,发送,已送达)会通知应用。

expireTime

Integer(>=0)

下发命令的超时时间,单位为秒,表示设备命令在创建后expireTime秒内有效,超过这个时间范围后命令将不再下发,如果未设置则默认为48小时(86400s*2)。

status

String

下发命令的状态。

  • DEFAULT表示未下发
  • EXPIRED表示命令已经过期
  • SUCCESSFUL表示命令已经成功执行
  • FAILED表示命令执行失败
  • TIMEOUT表示命令下发执行超时
  • CANCELED表示命令已经被撤销执行

result

ObjectNode

下发命令执行的详细结果。

creationTime

String(20)

命令创建的UTC时间,时间格式:yyyyMMdd'T'HHmmss'Z',如20151212T121212Z。

若需要显示本地时区时间,您需要自己进行时间转换。

executeTime

String(20)

命令执行的UTC时间,时间格式:yyyyMMdd'T'HHmmss'Z',如20151212T121212Z。

若需要显示本地时区时间,您需要自己进行时间转换。

platformIssuedTime

String(20)

平台发送命令的UTC时间,时间格式:yyyyMMdd'T'HHmmss'Z',如20151212T121212Z。

若需要显示本地时区时间,您需要自己进行时间转换。

deliveredTime

String(20)

平台将命令送达到设备的UTC时间,时间格式:yyyyMMdd'T'HHmmss'Z',如20151212T121212Z。

若需要显示本地时区时间,您需要自己进行时间转换。

issuedTimes

Integer(>=0)

平台发送命令的次数。

maxRetransmit

Integer(0~3)

命令下发最大重传次数。

CommandDTO:

参数

类型

描述

serviceId

String(1-64)

命令对应的服务ID,用于标识一个服务。

method

String(1-128)

命令服务下具体的命令名称,要与profile中定义的命令名保持一致。

paras

ObjectNode

命令参数,jsonString格式,里面是一个个健值对,每个健都是profile中命令的参数名(paraName),具体格式需要应用和设备约定。

请求示例

POST https://{host}:{port}/iocm/app/cmd/v1.4.0/deviceCommandCancelTasks?appId={appId}
Content-Type: application/json
app_key: ******
Authorization: Bearer ******

{
  "deviceId": "********"
}

正常响应示例

Status Code: 201 Created
Content-Type: application/json

{
  "taskId": "********",
  "appId": "********",
  "deviceId": "********",
  "status": "WAITTING",
  "totalCount": 1,
  "deviceCommands": [
    {
      "commandId": "********",
      "appId": "********",
      "deviceId": "********",
      "command": {
        "serviceId": "********",
        "method": "********",
        "paras": {
          "paraName1": "paraValue1",
          "paraName2": "paraValue2"
        }
      },
      "callbackUrl": "http://127.0.0.1:9999/cmd/callbackUrl",
      "expireTime": null,
      "status": "PENDDING",
      "result": null,
      "creationTime": "20170222T164000Z",
      "executeTime": null,
      "platformIssuedTime": null,
      "deliveredTime": null,
      "issuedTimes": null,
      "maxRetransmit": ******
    }
  ]
}

错误码

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是否有误。

400

100022

The input is invalid.

输入参数无效。

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

403

100203

The application is not existed.

应用不存在。

处理建议:

  • 请检查HTTP请求头域中携带的appId是否有误。
  • 请检查请求路径(url)中传入的appId是否有误。

403

100217

The application hasn't been authorized.

应用未被授权。

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

403

1010009

app throttle exceed.

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

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

403

1010005

Invalid access token or appId.

错误的token信息。

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

500

100001

Internal server error.

服务内部处理错误。

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

500

100220

Get AppKey from header failed.

获取appKey失败。

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

503

100501

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

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

相关使用指南

命令下发

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问