Creating Device Command Revocation Tasks

Typical Scenario

After an NA delivers commands to a device, the IoT platform does not deliver the commands to the device for execution (the commands are in the PENDING state) if the commands are in queue or the device is offline. In this case, the NA can call this API to revoke all the undelivered commands of a specified device. Commands that have been delivered cannot be revoked.

API Function

This API is used by an NA to create a command revocation task to revoke all undelivered commands (that is, commands in the PENDING state) with the specified device ID on the IoT platform.

API Prototype

Method	POST
URL	https://server:port/iocm/app/cmd/v1.4.0/deviceCommandCancelTasks?appId={appId}
Transport Protocol	HTTPS

Request Parameters

Parameter	Mandatory or Optional	Type	Location	Description
app_key	Mandatory	String	header	Identifies an application that can be accessed on the IoT platform. The value of this parameter is allocated by the IoT platform when the application is created on the platform.
Authorization	Mandatory	String	header	Indicates the authentication information for accessing the IoT platform. The value is Bearer {accessToken}, in which {accessToken} indicates the access token returned by the Authentication API.
appId	Optional	String	query	Identifies an application that can be accessed on the IoT platform. The value of this parameter is allocated by the IoT platform when the application is created on the platform. Set this parameter to the value of appId of the authorized application.
deviceId	Mandatory	String(1-64)	body	Uniquely identifies a device for which a command is to be revoked. The value of this parameter is allocated by the IoT platform during device registration. A command revocation task will revoke all commands delivered to the device.

Response Parameters

Status Code: 201 Created

Parameter	Type	Description
taskId	String(1-64)	Identifies a command revocation task.
appId	String(1-64)	Identifies the application to which the command revocation task belongs.
deviceId	String(1-64)	Uniquely identifies a device for which a command revocation task is executed. The value of this parameter is allocated by the IoT platform during device registration.
status	String	Indicates the revocation task status. WAITING: The task is waiting to be executed. RUNNING: The task is being executed. SUCCESS: The task has been successfully executed. FAILED: The task fails to be executed. PART_SUCCESS: Task execution partially succeeds.
totalCount	Integer	Indicates the total number of revoked commands.
deviceCommands	List<DeviceCommandResp>	Indicates a list of device commands to be revoked.

DeviceCommandResp structure

Parameter	Type	Description
commandId	String(1-64)	Uniquely identifies a device command. The value of this parameter is allocated by the IoT platform during command delivery.
appId	String(1-64)	Identifies the application to which the command revocation task belongs.
deviceId	String(1-64)	Uniquely identifies a device to which a command is delivered. The value of this parameter is allocated by the IoT platform during device registration.
command	CommandDTO	Indicates the command information.
callbackUrl	String(1024)	Indicates the URL for receiving command status change notifications. When the command status changes, such as execution failure, execution success, timeout, sending, or sent, the NA is notified.
expireTime	Integer(>=0)	Indicates the command expiration time, in seconds. That is, the validity period of the created device command is expireTime seconds. The command will not be delivered after the specified time elapses. If this parameter is not specified, the default validity period is 48 hours (86400 seconds x 2).
status	String	Indicates the status of the command. DEFAULT: The command has not been delivered. EXPIRED: The command has expired. SUCCESSFUL: The command has been successfully executed. FAILED: The command fails to be executed. TIMEOUT: Command execution times out. CANCELED: The command has been canceled.
result	ObjectNode	Indicates the detailed command execution result.
creationTime	String(20)	Indicates the time when the command is created.
executeTime	String(20)	Indicates the time when the command is executed.
platformIssuedTime	String(20)	Indicates the time when the IoT platform sends the command.
deliveredTime	String(20)	Indicates the time when the command is delivered to the device.
issuedTimes	Integer(>=0)	Indicates the number of times the IoT platform delivers a command.
maxRetransmit	Integer(0-3)	Indicates the maximum number of times the command is retransmitted.

CommandDTO structure

Parameter	Type	Description
serviceId	String(1-64)	Identifies the service corresponding to the command.
method	String(1-128)	Indicates the name of a specific command under the service. The value of this parameter must be the same as the command name defined in the profile file.
paras	ObjectNode	Indicates a command parameter in the jsonString format. The value consists of key-value pairs. Each key is the paraName parameter in commands in the profile file. The specific format depends on the application and device.

Request Example

Method: POST
Request:
https://server:port/iocm/app/cmd/v1.4.0/deviceCommandCancelTasks?appId={appId}
Header:
app_key: ******
Authorization: Bearer ******
Content-Type: application/json
Body:
{
  "deviceId": "********"
}

Response Example

Response:
Status Code: 201 Created
Content-Type: application/json
Body:
{
  "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": ******
    }
  ]
}

Error Codes

HTTP Status Code	Error Code	Error Description	Remarks
200	100203	The application is not existed.	The application does not exist. Recommended handling: Check whether appId carried in the HTTP request header is correct. Check whether appId in the request path (URL) is correct.
200	100217	The application hasn't been authorized.	The application has not been authorized. Recommended handling: In scenarios where applications are not authorized, ensure that request parameter appId is null.
200	100418	The deviceData is not existed.	The device data does not exist. Recommended handling: If deviceId carried in the request is incorrect, check whether deviceId belongs to appId or whether deviceId is incorrect. Check whether appId carried in the header contains deviceId. If the URL contains the optional parameter appId, check whether the value of appId is correct.
400	100022	The input is invalid.	An input parameter is invalid. Recommended handling: Check whether parameters carried in the API call request are valid.
403	100203	The application is not existed.	The application does not exist. Recommended handling: Check whether appId carried in the HTTP request header is correct. Check whether appId in the request path (URL) is correct.
403	100217	The application hasn't been authorized.	The application has not been authorized. Recommended handling: In scenarios where applications are not authorized, ensure that request parameter appId is null.
403	1010009	app throttle exceed.	The NA calls the API at a frequency that exceeds the flow control threshold (100 calls per minute by default). Recommended handling: Contact IoT platform maintenance personnel to adjust the flow control threshold or control the API call frequency.
403	1010005	App_key or access_token is invalid.	The access token is invalid. Recommended handling: Check whether accessToken carried in the API request is correct.
500	100001	Internal server error.	An internal server error occurs. Recommended handling: An internal error occurs on the IoT platform. Contact IoT platform maintenance personnel.
500	100220	Get AppKey from header failed.	Failed to obtain the appKey. Recommended handling: Check whether appId is carried in the API request header.
503	100501	Congestion occurs, and the current network has been flow-controlled	Congestion occurs. The current network is under flow control.