Updated at: 2022-02-24 GMT+08:00

Modifying Device Commands

Typical Scenario

NAs can call this API to modify the status of commands that have not been canceled, expired, or executed. Currently, the status of such commands can only be changed to Canceled.

API Function

This API is used by NAs to modify the status of commands. Currently, the status of commands can only be changed to Canceled. That is, the commands are revoked.

API Description

1
def updateDeviceCommand(self, udcInDTO, deviceCommandId, appId, accessToken)

Parameter Description

Parameter

Mandatory or Optional

Type

Location

Description

udcInDTO

Mandatory

UpdateDeviceCommandInDTO

body

For details, see UpdateDeviceCommandInDTO structure.

deviceCommandId

Mandatory

String

path

Identifies the command whose status is to be modified. The value of this parameter is obtained after the API used for creating device commands is called.

appId

Optional

String

query

If the device belongs to the current application, set this parameter to None. Otherwise, set this parameter to the ID of the authorized application.

accessToken

Mandatory

String

header

This parameter is set to the value of the access token obtained by calling the Authentication API.

UpdateDeviceCommandInDTO structure

Parameter

Mandatory or Optional

Type

Location

Description

status

Mandatory

String

body

Indicates the command execution result. The value can be CANCELED, which indicates that the command is revoked.

Response Parameters

UpdateDeviceCommandOutDTO

Parameter

Type

Description

commandId

String(1-64)

Identifies a device command.

appId

String(1-64)

Uniquely identifies an NA. This parameter is used to identify an NA that can call open APIs provided by the IoT platform.

deviceId

String(1-64)

Uniquely identifies the device that delivers the command.

command

CommandDTOV4

Indicates information about the delivered command. For details, see CommandDTOV4 structure.

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 units of seconds. The command will not be delivered after the specified time elapses. 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.

issuedTimes

Integer(>=0)

Indicates the number of times the IoT platform delivers the command.

maxRetransmit

Integer(0~3)

Indicates the maximum number of times the command can be retransmitted.

CommandDTOV4 structure

Parameter

Mandatory or Optional

Type

Location

Description

serviceId

Mandatory

String(1-64)

body

Identifies the service corresponding to the command.

method

Mandatory

String(1-128)

body

Indicates the command name.

paras

Optional

Object

body

Indicates a JSON string of command parameters. The specific format is negotiated by the NA and the device.

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.

200

100428

The device is not online.

The device is not online.

Recommended handling: Check whether the connection between the device and the IoT platform is normal.

200

100431

The serviceType is not exist.

The service type does not exist.

Recommended handling:

  • Check whether the profile file of the device has been uploaded to the IoT platform.
  • Check whether the request parameters are correct and whether serviceId exists in the profile file.

200

100434

The device command is not existed.

The device command does not exist.

Recommended handling: Check whether the device command ID in the request is correct.

200

100435

The device command already canceled, expired or executed, Cannot cancel.

The device command has been canceled, expired, or executed. It cannot be canceled.

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

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

100023

The data in dataBase is abnomal.

The database is abnormal.

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.

500

101016

Get iotws address failed.

Failed to obtain the IoTWS address.

Recommended handling: An internal error occurs on the IoT platform. Contact IoT platform maintenance personnel.

500

101017

Get newCallbackUrl from oss failed.

Obtaining a new callback URL from the OSS fails.

Recommended handling: An internal error occurs on the IoT platform. Contact IoT platform maintenance personnel.

503

100501

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

Congestion occurs. The current network is under flow control.

close