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	public function queryDeviceDesiredHistory($qddhInDTO, $accessToken)

Parameter Description

Parameter	Mandatory or Optional	Location	Description
$qddhInDTO	Mandatory	query	For details, see QueryDeviceDesiredHistoryInDTO structure.
$accessToken	Mandatory	header	This parameter is set to the value of the access token obtained by calling the Authentication API.

QueryDeviceDesiredHistoryInDTO

Parameter	Mandatory or Optional	Location	Description
$appId	Mandatory	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	query	Identifies a device.
$gatewayId	Mandatory	query	Identifies a gateway.
$serviceId	Optional	query	Identifies a service.
$property	Optional	query	Indicates the service attribute.
$pageNo	Optional	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	query	Indicates the number of records on each page. The default value is 1.
$startTime	Optional	query	Indicates the start time. Historical 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	query	Indicates the end time. Historical 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

Parameter	Description
$totalCount	Indicates the number of queried records.
$pageNo	Indicates the page number.
$pageSize	Indicates the number of records on each page.
$DeviceDesiredHistoryDTO	Indicates a list of historical device data. For details, see DeviceDesiredHistoryDTO structure.

DeviceDesiredHistoryDTO structure

Parameter	Description
$serviceId	Identifies a service.
$deviceId	Identifies a device.
$gatewayId	Identifies a gateway.
$appId	Uniquely identifies an NA.
$desired	Indicates the data reported by the device.
$timestamp	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.