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

Querying Device Commands

Typical Scenario

After an NA delivers a command to a device, the NA can call this API to query the status and content of the delivered command on the IoT platform to check the command execution status.

API Function

This API is used by an NA to query the status and content of delivered commands on the IoT platform. All the commands delivered by the current application in a specified period or all the commands delivered to a specified device can be queried.

API Description

1
QueryDeviceCommandOutDTO2 queryDeviceCommand(QueryDeviceCommandInDTO2 qdcInDTO, String accessToken) throws NorthApiException

Parameter Description

Parameter

Mandatory or Optional

Type

Location

Description

qdcInDTO

Mandatory

QueryDeviceCommandInDTO2 structure

query

For details, see QueryDeviceCommandInDTO2 structure.

accessToken

Mandatory

String

header

If the Periodically Refreshing a Token API is called, set this parameter to null. Otherwise, set this parameter to the accessToken obtained by the Authentication API.

QueryDeviceCommandInDTO2 structure

Parameter

Mandatory or Optional

Type

Location

Description

pageNo

Optional

Integer(>=0)

query

Indicates the page number. The value is greater than or equal to 0. The default value is 0.

pageSize

Optional

Integer(>=1&&<=1000)

query

Indicates the number of records to be displayed on each page. The value ranges from 1 to 1000. The default value is 1000.

deviceId

Optional

String(64)

query

Identifies the device whose commands are to be queried.

startTime

Optional

String

query

Indicates the start time. Commands delivered later than the start time are queried. The value is in the format of yyyyMMdd'T'HHmmss'Z'. An example value is 20151212T121212Z.

endTime

Optional

String

query

Indicates the end time. Commands delivered earlier than the end time are queried. The value is in the format of yyyyMMdd'T'HHmmss'Z'. An example value is 20151212T121212Z.

appId

Optional

String

query

If the command belongs to the current application, set this parameter to null. Otherwise, set this parameter to the ID of the authorized application.

Response Parameters

QueryDeviceCommandOutDTO2 structure

Parameter

Type

Description

pagination

Pagination

Indicates pagination information. For details, see Pagination structure.

data

List<DeviceCommandRespV4>

Indicates the device command list. For details, see DeviceCommandRespV4 structure.

Pagination structure

Parameter

Type

Description

pageNo

long

Indicates the page number.

pageSize

long

Indicates the number of records to be displayed on each page.

totalSize

long

Indicates the total number of records.

DeviceCommandRespV4 structure

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.

  • PENDING: 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.
  • DELIVERED: The command has been delivered.
  • SENT: The command is being delivered.

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

Description

serviceId

Mandatory

String(1-64)

Identifies the service corresponding to the command.

method

Mandatory

String(1-128)

Indicates the command name.

paras

Optional

Object

Indicates the command parameter, which is a JSON string. The specific format is negotiated by the NA and 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.

400

100022

The input is invalid.

An input parameter is invalid.

Recommended handling:

  • Ensure that neither startTime nor endTime is null and the value of endTime is later than that of startTime.
  • Ensure that pageNo is not null and the value of pageNo is greater than 0.
  • Ensure that pageSize is not null and the value of pageSize is greater than 1.

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

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