Query Devices in Project

Last Updated on : 2024-07-03 07:34:34download

Query the list of devices under a specified cloud project. You can filter the device list by product ID and category.

API address

GET: /v2.0/cloud/thing/device

Request parameter

Parameter name	Type	IN	Required	Description
product_ids	String	query	false	The list of up to 5 product IDs, separated with commas (,).
categories	String	query	false	The list of up to 5 product categories, separated with commas (,).
last_id	String	query	false	The last device ID returned by the previous page. This parameter is not passed in case of the first page.
page_size	Integer	query	true	The number of items returned on each page. Maximum value: `20`.

Return parameter

Parameter name	Type	Description
result	List	The list of returned data.
success	Boolean	Indicates whether the operation is successful. Valid values: `true`: The operation succeeded. `false`: The operation failed.
t	Long	The timestamp.
tid	String	The link ID.

Description of result

Parameter name	Type	Description
id	String	The device ID.
category	String	The product category of the specified device.
icon	String	The icon of the specified device.
ip	String	The IP address of the specified device.
lat	String	The latitude where the device is located.
lon	String	The longitude where the device is located.
name	String	The name of the specified device.
sub	Boolean	Indicates whether the specified device is a sub-device.
uuid	String	The universally unique identifier (UUID) of the specified device.
activeTime	Long	The timestamp when the device was activated. Unit: seconds.
createTime	Long	The timestamp when the device was paired for the first time. Unit: seconds.
updateTime	Long	The timestamp when the device was updated. Unit: seconds.
customName	String	The custom name of the specified device.
isOnline	Boolean	Indicates whether the specified device is online.
localKey	String	The unique encrypted key of the specified device over LAN.
productId	String	The product ID of the specified device.
productName	String	The product name of the specified device.
timeZone	String	The time zone in which the specified device is located.

Request example

GET: /v2.0/cloud/thing/device?product_ids=h9sabcugftb***

Return example

{
    "tid": "a8bcb54fb8e411eda71e169efc83a172",
    "result": [
        {
            "sub": false,
            "productId": "h9soglkuugftb***",
            "activeTime": 1659422574,
            "ip": "124.90.34.***",
            "icon": "smart/icon/baydffaa6539efg/a6cdd065abcde3bfb689152eda***.png",
            "timeZone": "+8.0",
            "customName": "Robot Vacuum in Living Room",
            "isOnline": true,
            "lon": "20.0641",
            "updateTime": 1659422574,
            "uuid": "vdevo165abcd98***",
            "productName": "Robot Vacuum A001",
            "createTime": 1659422574,
            "name": "Robot Vacuum-vdevo",
            "id": "vdevo165abcd98***",
            "category": "cz",
            "lat": "50.3029",
            "localKey": "06f4adf1e5fc4***"
        }
    ],
    "t": 1677752774750,
    "success": true
}

Error code

For more information, see error code.

Limits on API Request Frequency

For more information, see Limits on API Request Frequency.

Prev DocDevice Management

Next DocQuery Devices in Space