Help Center > > API Reference> Northbound Java SDK API Reference> Service API List> Device Management> Querying Device Shadow Information

Querying Device Shadow Information

Updated at: Aug 28, 2019 GMT+08:00

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
QueryDeviceShadowOutDTO queryDeviceShadow(String deviceId, String appId, String accessToken) throws NorthApiException

Class

DeviceManagement

Parameter Description

Parameter

Mandatory or Optional

Type

Location

Description

deviceId

Mandatory

String

path

Identifies a device. The device ID is allocated by the IoT platform during device registration.

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.

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.

Return Value

QueryDeviceShadowOutDTO

Parameter

Type

Description

deviceId

String(36)

Identifies a device.

gatewayId

String(36)

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.

nodeType

Enum

Indicates the device type.

createTime

String(256)

Indicates the device creation time.

lastModifiedTime

String(256)

Indicates the last modification time.

deviceInfo

DeviceInfo

Indicates the device information. For details, see DeviceInfo structure.

services

List<DeviceServiceB>

Indicates service capabilities of the device. For details, see DeviceServiceB structure.

DeviceInfo structure

Parameter

Type

Description

nodeId

String(256)

Identifies a device.

name

String(256)

Indicates the device name.

description

String(2048)

Indicates the device description.

manufacturerId

String(256)

Uniquely Identifies the manufacturer. Set this parameter to the value defined in the profile file of the device.

manufacturerName

String(256)

Indicates the manufacturer name. Set this parameter to the value defined in the profile file of the device.

mac

String(256)

Indicates the MAC address of the device.

location

String(2048)

Indicates the device location.

deviceType

String(256)

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

String(256)

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

String(256)

Indicates the software version of the device.

In Z-Wave, the format is major version.minor version, for example, 1.1.

fwVersion

String(256)

Indicates the firmware version of the device.

hwVersion

String(256)

Indicates the hardware version of the device.

protocolType

String(256)

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

String(256)

Identifies the bridge through which the device accesses the IoT platform.

status

String

Indicates whether the device is online. The value options are ONLINE, OFFLINE, and ABNORMAL.

statusDetail

String(256)

Indicates the device status details. The value of this parameter varies with the value of status. For details, see status and statusDetail structure.

mute

String

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

String

Indicates whether the security mode is supported.

  • TRUE: The security mode is supported.
  • FALSE: The security mode is not supported.

isSecurity

String

Indicates whether the security mode is enabled.

  • TRUE: The security mode is enabled.
  • FALSE: The security mode is disabled.

signalStrength

String(256)

Indicates the signal strength of the device.

sigVersion

String(256)

Indicates the SIG version of the device.

serialNumber

String(256)

Indicates the serial number of the device.

batteryLevel

String(256)

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

Type

Description

serviceId

String(256)

Identifies a service.

reportedProps

ObjectNode

Indicates the latest information reported by the device.

desiredProps

ObjectNode

Indicates the configuration information delivered to the device.

eventTime

String(256)

Indicates the time when an event occurs.

serviceType

String(256)

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.

Did you find this page helpful?

Submit successfully!

Thank you for your feedback. Your feedback helps make our documentation better.

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