Querying Historical Device Shadow Data

Typical Scenario

When an NA modifies the configuration of a device shadow by calling the Modifying Device Shadow Information API, 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 Prototype

Method	GET
URL	https://server:port/iocm/app/shadow/v1.5.0/deviceDesiredHistory?deviceId={deviceId}&gatewayId={gatewayId}&appId={appId}&serviceId={serviceId}&property={property}&pageNo={pageNo}&pageSize={pageSize}&startTime={startTime}&endTime={endTime}
Transport Protocol	HTTPS

Request Parameters

Parameter	Mandatory or Optional	Type	Location	Description
app_key	Mandatory	String	header	Identifies an application that can be accessed on the IoT platform. The value of this parameter is allocated by the IoT platform when the application is created on the platform.
Authorization	Mandatory	String	header	Indicates the authentication information for accessing the IoT platform. The value is Bearer {accessToken}, in which {accessToken} indicates the access token returned by the Authentication API.
appId	Optional	String	query	Identifies an application that can be accessed on the IoT platform. The value of this parameter is allocated by the IoT platform when the application is created on the platform. Set this parameter to the value of appId of the authorized application.
deviceId	Mandatory	String	query	Uniquely identifies a device. The value of this parameter is allocated by the IoT platform during device registration.
gatewayId	Mandatory	String	query	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 an indirectly connected device, the gateway ID is the device ID of the directly connected device (that is, the gateway) with which it associates.
serviceId	Optional	String	query	Identifies a service.
property	Optional	String	query	Indicates the service attribute.
pageNo	Optional	Integer	query	Indicates the page number to be queried. The value is an integer greater than or equal to 0. The default value is 0, indicating that the first page is queried.
pageSize	Optional	Integer	query	Indicates the number of records to be displayed on each page. Pagination is implemented based on the value of this parameter. The value is an integer ranging from 1 to 250. The default value is 25.
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

Status Code: 200 OK

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 list of historical device shadow configuration data.

DeviceDesiredHistoryDTO structure:

Parameter	Type	Description
serviceId	String(256)	Identifies a service.
deviceId	String(256)	Uniquely identifies a device. The value of this parameter is allocated by the IoT platform during device registration.
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 an indirectly 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)	Identifies the application to which the device belongs.
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.

Request Example

Method: GET
Request:
https://server:port/iocm/app/shadow/v1.5.0/deviceDesiredHistory?deviceId={deviceId}&gatewayId={gatewayId}&appId={appId}&serviceId={serviceId}&property={property}&pageNo={pageNo}&pageSize={pageSize}&startTime={startTime}&endTime={endTime}
Header:
app_key: ******
Authorization: Bearer *****
Content-Type: application/json

Response Example

Response:
Status Code: 200 OK
Content-Type: application/json
Body:
{
    "totalCount":"****",
    "pageNo":"*****",
    "pageSize":"*****",
    "DeviceDesiredHistoryDTO":[
        {
            "serviceId":"*****",
            "deviceId":"*****",
            "gatewayId":"*****",
            "appId":"*****",
            "desired":"*****",
            "timestamp":"*****"
        }
    ]
}

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.