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
Koo Command Line Interface
Updated at: Feb 24, 2022 GMT+08:00

Querying Historical Device Shadow Data

Typical Scenario

When an NA modifies the configuration of a device shadow by calling the API for modifying device shadow information, the IoT platform saves the modification record. If the NA needs to view historical configuration records of the device shadow, the NA can call this API to obtain the records.

API Function

This API is used by an NA to query historical configuration data about a device shadow based on the device ID.

API Description

1
QueryDeviceDesiredHistoryOutDTO queryDeviceDesiredHistory(QueryDeviceDesiredHistoryInDTO qddhInDTO, String accessToken) throws NorthApiException

Parameter Description

Parameter

Mandatory or Optional

Type

Location

Description

qddhInDTO

Mandatory

QueryDeviceDesiredHistoryInDTO structure

query

For details, see QueryDeviceDesiredHistoryInDTO 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.

QueryDeviceDesiredHistoryInDTO structure

Parameter

Mandatory or Optional

Type

Location

Description

appId

Mandatory

String

query

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

deviceId

Mandatory

String

query

Identifies a device.

gatewayId

Mandatory

String

query

Identifies a gateway.

serviceId

Optional

String

query

Identifies a service.

property

Optional

String

query

Indicates the service attribute.

pageNo

Optional

Integer

query

Indicates the page number.

  • If the value is null, pagination query is not performed.
  • If the value is an integer greater than or equal to 0, pagination query is performed.
  • If the value is 0, the first page is queried.

pageSize

Optional

Integer

query

Indicates the number of records on each page. The default value is 1.

startTime

Optional

String

query

Indicates the start time. Historical shadow data generated later than the specified start time is 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. Historical shadow data generated earlier than the specified end time is queried. The value is in the format of yyyyMMdd'T'HHmmss'Z'. An example value is 20151212T121212Z.

Response Parameters

QueryDeviceDesiredHistoryOutDTO structure

Parameter

Type

Description

totalCount

Long

Indicates the number of queried records.

pageNo

Long

Indicates the page number.

pageSize

Long

Indicates the number of records on each page.

DeviceDesiredHistoryDTO

List<DeviceDesiredHistoryDTO>

Indicates the historical configuration data about a device shadow. For details, see DeviceDesiredHistoryDTO structure.

DeviceDesiredHistoryDTO structure

Parameter

Type

Description

serviceId

String(256)

Identifies a service.

deviceId

String(256)

Identifies a device.

gatewayId

String(256)

Identifies a gateway. The gateway ID is the same as the device ID if the device is a directly connected device. If the device is a non-directly connected device, the gateway ID is the device ID of the directly connected device (that is, the gateway) with which it associates.

appId

String(256)

Uniquely identifies an NA.

desired

JsonObject

Indicates the configuration information delivered to the device.

timestamp

String(256)

Indicates the timestamp when the data is configured. The value is in the format of yyyyMMdd'T'HHmmss'Z', for example, 20151212T121212Z.

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.

400

100216

The application input is invalid.

The application input is invalid.

Recommended handling: Check whether parameters in the API request are correct by referring to the request parameter description.

400

100419

The deviceId and gatewayId can't be both null.

The deviceId and gatewayId parameters cannot be null at the same time.

Recommended handling: Check whether deviceId or gatewayId is set.

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

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.

500

50252

Internal server error.

An internal server error occurs.

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

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