Querying Device Shadow Information

Typical Scenario

When a device is in the offline or abnormal state, an NA cannot deliver configuration information to the device by sending a command. In this case, the NA can deliver the configuration information to the device shadow. When the device goes online, the device shadow will deliver the configuration information to the device. The NA can call this API to check the device configuration information and the latest data reported by the device on the device shadow.

API Function

This API is used by an NA to query the device shadow information of a device, including the device configuration information (in the desired section) and the latest data reported by the device (in the reported section).

API Description

1	public function queryDeviceShadow($deviceId, $appId, $accessToken)

Class

DeviceManagement

Parameter Description

Parameter	Mandatory or Optional	Location	Description
$deviceId	Mandatory	path	Identifies a device. The device ID is allocated by the IoT platform during device registration.
$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.
$accessToken	Mandatory	header	This parameter is set to the value of the access token obtained by calling the Authentication API.

Return Value

Status Code: 200 OK

QueryDeviceShadowOutDTO

Parameter	Description
$deviceId	Identifies a device.
$gatewayId	Identifies a gateway.
$nodeType	Indicates the device type.
$createTime	Indicates the device creation time.
$lastModifiedTime	Indicates the last modification time.
$deviceInfo	Indicates the device information. For details, see DeviceInfo structure.
$services	Indicates the service capabilities of the device. For details, see DeviceServiceB structure.

DeviceInfo structure

Parameter	Description
$nodeId	Identifies a device.
$name	Indicates the device name.
$description	Indicates the device description.
$manufacturerId	Uniquely identifies a manufacturer. Set this parameter to the value defined in the profile file of the device.
$manufacturerName	Indicates the manufacturer name. Set this parameter to the value defined in the profile file of the device.
$mac	Indicates the MAC address of the device.
$location	Indicates the device location.
$deviceType	Indicates the device type. The upper camel case is used. Set this parameter to the value defined in the profile file of the device, for example, MultiSensor, ContactSensor, and CameraGateway.
$model	Indicates the device model. Set this parameter to the value defined in the profile file of the device. In Z-Wave, the format is productType + productId. The value is a hexadecimal value in the format of XXXX-XXXX. Zeros are added if required, for example, 001A-0A12. The format in other protocols is still to be determined.
$swVersion	Indicates the software version of the device. In Z-Wave, the format is major version.minor version, for example, 1.1.
$fwVersion	Indicates the firmware version of the device.
$hwVersion	Indicates the hardware version of the device.
$protocolType	Indicates the protocol type used by the device. Set this parameter to the value defined in the profile file of the device. The value options are CoAP, huaweiM2M, Z-Wave, ONVIF, WPS, Hue, WiFi, J808, Gateway, ZigBee, and LWM2M.
$bridgeId	Identifies the bridge through which the device accesses the IoT platform.
$status	Indicates whether the device is online. The value options are ONLINE, OFFLINE, INBOX, and ABNORMAL.
$statusDetail	Indicates the device status. The specific value is determined by the value of status. For details, see status and statusDetail.
$mute	Indicates whether the device is in the frozen state. Based on the value of this parameter, the IoT platform determines whether to manage and store data reported by the device. TRUE: The device is in the frozen state. FALSE: The device is not in the frozen state.
$supportedSecurity	Indicates whether the security mode is supported. TRUE: The security mode is supported. FALSE: The security mode is not supported.
$isSecurity	Indicates whether the security mode is enabled. TRUE: The security mode is enabled. FALSE: The security mode is disabled.
$signalStrength	Indicates the signal strength of the device.
$sigVersion	Indicates the SIG version of the device.
$serialNumber	Indicates the serial number of the device.
$batteryLevel	Indicates the battery level of the device.

status and statusDetail

status	statusDetail
OFFLINE	NONE CONFIGURATION_PENDING
ONLINE	NONE COMMUNICATION_ERROR CONFIGURATION_ERROR BRIDGE_OFFLINE FIRMWARE_UPDATING DUTY_CYCLE NOT_ACTIVE

NOTE:

When the device status information is reported to the IoT platform, status and statusDetail must be included. It is recommended that statusDetail be used only for display but not for logical judgment.

DeviceServiceB structure

Parameter	Description
$serviceId	Identifies a service.
$reportedProps	Indicates the information reported by the device.
$desiredProps	Indicates the information delivered to the device.
$eventTime	Indicates the time when an event occurs.
$serviceType	Indicates the service type.

Error Codes

HTTP Status Code	Error Code	Error Description	Remarks
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	pp_key or access_token is invalid.	The access token is invalid. Recommended handling: Check whether accessToken carried in the API request is correct.
404	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.
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.