Get Device Information

Last Updated on : 2023-06-28 08:17:31download

Get the device information by the device ID.

API address

GET: /v1.1/iot-03/devices/{device_id}

Request parameter

Parameter nameTypeINRequiredDescription
device_idStringuritrueThe device ID.

Return parameter

Parameter nameTypeDescription
resultBaseDeviceResThe returned result.

Description of result

Parameter nameTypeDescription
idStringThe device ID.
gateway_idStringThe gateway ID. The value is empty for non-gateway sub-devices.
node_idStringThe node ID. The value is empty for non-gateway sub-devices.
uuidStringThe universally unique identifier (UUID) of the specified device.
categoryStringThe category of the specified product.
category_nameStringThe name of the specified product category.
nameStringThe name of the specified device.
product_idStringThe product ID (PID).
product_nameStringThe name of the specified product.
local_keyStringThe secret key.
subBooleanIndicates whether the specified device is a sub-device.
asset_idStringThe asset ID.
owner_idStringThe home ID.
ipStringThe IP address of the specified device.
lonStringThe longitude.
latStringThe latitude.
modelStringThe product model.
time_zoneStringThe time zone.
active_timeLongThe time when a device is activated.
update_timeLongThe time when a device is updated.
create_timeLongThe time when the device is paired for the first time.
onlineBooleanThe online status of the specified device.
iconStringThe icon of the specified device.
snStringThe serial number of the specified device.

Request example

GET: /v1.1/iot-03/devices/xxxxId

Return example

    "result": {
        "result": {
            "sub": false,
            "category_name": "Light Source",
            "create_time": 1567395627,
            "local_key": "8ab649951d59****",
            "owner_id": "31256829",
            "ip": "124.90.**.***",
            "icon": "smart/icon/1526276264k8q8l44swr2ennf6zx5u92j***.png",
            "lon": "120.0638",
            "time_zone": "+08:00",
            "product_name": "Light",
            "uuid": "38042025cc50e325****",
            "gateway_id": "",
            "active_time": 1620299529,
            "update_time": 1635941286,
            "product_id": "ylr9R01cMWnM****",
            "name": "Light",
            "online": true,
            "model": "LE7",
            "id": "38042025cc50e325****",
            "sn": "693511713****",
            "category": "dj",
            "lat": "30.3027"
        "t": 1635941588278,
        "success": true
    "t": 1635941588278,
    "success": true

Error code

For more information, see error code.