Cloud Services API ReferenceIndustrial ScenariosIndustry Basic ServiceGeneral Device ManagementGet Device Information

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 name	Type	IN	Required	Description
device_id	String	uri	true	The device ID.

Return parameter

Parameter name	Type	Description
result	BaseDeviceRes	The returned result.

Description of result

Parameter name	Type	Description
id	String	The device ID.
gateway_id	String	The gateway ID. The value is empty for non-gateway sub-devices.
node_id	String	The node ID. The value is empty for non-gateway sub-devices.
uuid	String	The universally unique identifier (UUID) of the specified device.
category	String	The category of the specified product.
category_name	String	The name of the specified product category.
name	String	The name of the specified device.
product_id	String	The product ID (PID).
product_name	String	The name of the specified product.
local_key	String	The secret key.
sub	Boolean	Indicates whether the specified device is a sub-device.
asset_id	String	The asset ID.
owner_id	String	The home ID.
ip	String	The IP address of the specified device.
lon	String	The longitude.
lat	String	The latitude.
model	String	The product model.
time_zone	String	The time zone.
active_time	Long	The time when a device is activated.
update_time	Long	The time when a device is updated.
create_time	Long	The time when the device is paired for the first time.
online	Boolean	The online status of the specified device.
icon	String	The icon of the specified device.
sn	String	The 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.

Prev DocModify Frozen Status

Next DocGet Device Specification