V2.1 Cancel Command task¶

取消缓存命令的接口。如果有 commandId，则取消单个命令，如果无 commandId，则取消该设备的所有缓存命令。

该 API 支持在 EnOS 2.1.0 及以上环境中使用。

操作权限¶

确保已获取调用该 API 的权限。更多信息，参见获取 API 调用权限。

请求格式¶

POST https://{apigw-address}/connect-service/v2.1/commands?action=cancel

请求参数（URI）¶

备注

以下非必需字段中，必须提供 assetId 或 productKey + deviceKey 的组合，用于指定设备。

名称	位置（Path/Query）	必需/可选	数据类型	描述
orgId	Query	必需	String	设备所属的 OU ID。如何获取 orgId 信息>>
assetId	Query	可选（见上述注解）	String	设备的 asset ID。如何获取 assetId 信息>>
productKey	Query	可选（见上述注解）	String	设备的 product key，需与 `deviceKey` 一起使用。如何获取设备的三元组信息>>
deviceKey	Query	可选（见上述注解）	String	设备的 device key，需与 `productKey` 一起使用。如何获取设备的三元组信息>>
commandId	Query	可选	String	命令 ID。

响应参数¶

名称	数据类型	描述
data	Command 结构体数组	被取消的命令列表，其结构参见 Command 结构体。

Command 结构体 ¶

名称	数据类型	描述
commandId	String	命令 ID
orgId	String	命令所属的 OU ID。
productKey	String	设备的 Product Key。
deviceKey	String	设备的 Device Key。
assetId	String	设备的 asset ID。
createTime	String	创建时间。
createLocaltime	String	本地创建时间。
commandType	Integer	命令类型。1. 测点设置 2. 服务调用。
commandName	StringI18n	命令的名称。
timeout	Integer	命令超时时长，单位是秒，范围[1-60]，默认30。
pendingTtl	Long	命令缓存时长，单位是秒，范围[ 0 - 48 * 60 * 60 ]，默认0，表示即时命令。
state	Integer	命令状态，用1-7的整数表示。 1表示已创建；2表示已取消；3表示已过期；4表示已下发；5表示发送成功；6表示发送失败；7表示响应超时。
tslIdentifier	String	命令标识符。
inputData	Map（Key为String，Value为String，Number，Array或Object）	输入参数。key为输入参数标识符，value的数据类型需要符合模型的定义。
outputData	Map（ Key 为String，Value 为S tring，Number，Array 或 Object）	输出数据。key 为输出参数标识符，value 为服务的输出结果。其中 value 的数据类型需要符合模型的定义。

错误码¶

代码	错误信息	描述
11404	Command not found	`commandId` 未找到或不存在。
11905	Cache message cancel error, not created state	该命令已被撤销。

示例¶

请求示例¶

url:https://{apigw-address}/connect-service/v2.1/commands?action=cancel&deviceKey=yourDeviceKey&productKey=yourProductKey&orgId=yourOrgId
method: POST

返回示例¶

{
    "code": 0,
    "msg": "OK",
    "requestId": "7d863d517eae4f18a2776452eb1305bb",
    "data": [{
        "commandId": "2278935391225618432",
        "orgId": "yourOrgId",
        "productKey": "yourProductKey",
        "deviceKey": "yourDeviceKey",
        "assetId": "yourAssetId",
        "createTime": "1560505243577",
        "createLocalTime": "2019-06-14 17:40:23",
        "commandType": 1,
        "commandName": {
            "defaultValue": "Int_value",
            "i18nValue": {
                "en_US": "Int_value"
            }
        },
        "timeout": 1,
        "pendingTtl": 6000,
        "state": 1,
        "tslIdentifier": "Int_value",
        "inputData": 222,
        "outputData": null
    }]
}

SDK 示例¶

你可以在 Github 上获取接入服务的 SDK 示例：

Java
Python