IoTIoT

Compute
Elastic Cloud Server
Bare Metal Server
Auto Scaling
Image Management Service
Dedicated Host
FunctionGraph
Networking
Virtual Private Cloud
Elastic IP
Elastic Load Balance
NAT Gateway
Direct Connect
Virtual Private Network
Domain Name Service
VPC Endpoint
Cloud Connect
Enterprise Switch
Security & Compliance
Anti-DDoS
Web Application Firewall
Host Security Service
Data Encryption Workshop
Database Security Service
Advanced Anti-DDoS
Data Security Center
Container Guard Service
Situation Awareness
Managed Threat Detection
Compass
Cloud Certificate Manager
Anti-DDoS Service
Databases
Relational Database Service
Document Database Service
Data Admin Service
Data Replication Service
GaussDB NoSQL
GaussDB(for MySQL)
Distributed Database Middleware
GaussDB(for openGauss)
Developer Services
ServiceStage
Distributed Cache Service
Simple Message Notification
Application Performance Management
Application Operations Management
Blockchain Service
API Gateway
Cloud Performance Test Service
Distributed Message Service for Kafka
Distributed Message Service for RabbitMQ
Distributed Message Service for RocketMQ
Cloud Service Engine
DevCloud
ProjectMan
CodeHub
CloudRelease
CloudPipeline
CloudBuild
CloudDeploy
Cloud Communications
Message & SMS
Cloud Ecosystem
Marketplace
Partner Center
User Support
My Account
Billing Center
Cost Center
Resource Center
Enterprise Management
Service Tickets
HUAWEI CLOUD (International) FAQs
ICP License Service
Support Plans
Customer Operation Capabilities
Partner Support Plans
Professional Services
enterprise-collaboration
Meeting
IoT
IoT
Intelligent EdgeFabric
DeveloperTools
SDK Developer Guide
API Request Signing Guide
Terraform
HCloud CLI
Updated at: Feb 24, 2022 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
public function queryDeviceCommand($qdcInDTO, $accessToken)

Parameter Description

Parameter

Mandatory or Optional

Location

Description

$qdcInDTO

Mandatory

query

For details, see QueryDeviceCommandInDTO structure.

$accessToken

Mandatory

header

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

QueryDeviceCommandInDTO

Parameter

Mandatory or Optional

Location

Description

$pageNo

Optional

query

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

$pageSize

Optional

query

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

$deviceId

Optional

query

Identifies the device whose commands are to be queried.

$startTime

Optional

query

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

$endTime

Optional

query

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

$appId

Optional

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

QueryDeviceCommandOutDTO

Parameter

Description

$pagination

Indicates pagination information. For details, see Pagination structure.

$data

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

Pagination structure

Parameter

Description

$pageNo

Indicates the page number.

$pageSize

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

$totalSize

Indicates the total number of records.

DeviceCommandRespV4 structure

Parameter

Description

$commandId

Identifies a device command.

$appId

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

$deviceId

Uniquely identifies the device to which the command is delivered.

$command

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

$callbackUrl

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

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

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

Indicates the detailed command execution result.

$creationTime

Indicates the time when the command is created.

$executeTime

Indicates the time when the command is executed.

$platformIssuedTime

Indicates the time when the IoT platform sends the command.

$deliveredTime

Indicates the time when the command is delivered.

$issuedTimes

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

$maxRetransmit

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

CommandDTOV4 structure

Parameter

Mandatory or Optional

Description

$serviceId

Mandatory

Identifies the service corresponding to the command.

$method

Mandatory

Indicates the command name.

$paras

Optional

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.

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.

Did you find this page helpful?

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?







Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel