Cloud Services API ReferenceIoT CoreDevice ManagementQuery Devices in Project

Query Devices in Project

Last Updated on : 2023-11-23 06:46:28download

Query the list of devices in the specified project on pages, based on the list of product IDs and product categories.

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.
active_time	Long	The timestamp when the device was activated. Unit: seconds.
category	String	The product category of the specified device.
create_time	Long	The timestamp when the device was paired for the first time. Unit: seconds.
update_time	Long	The timestamp when the device was updated. Unit: seconds.
custom_name	String	The custom name of the specified device.
icon	String	The icon of the specified device.
ip	String	The IP address of the specified device.
is_online	Boolean	Indicates whether a device is online.
lat	String	The latitude of the specified device.
local_key	String	The unique encrypted key of the specified device over LAN.
lon	String	The longitude of the specified device.
name	String	The name of the specified device.
product_id	String	The product ID of the specified device.
product_name	String	The product name of the specified device.
sub	Boolean	Indicates whether the specified device is a sub-device.
time_zone	String	The time zone in which the specified device is located.
uuid	String	The universally unique identifier (UUID) of the specified device.

Request example

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

Return example

{
    "tid": "a8bcb54fb8e411eda71e169efc83a172",
    "result": [
        {
            "sub": false,
            "create_time": 1659422574,
            "local_key": "06f4adf1e5fc4***",
            "ip": "124.90.34.***",
            "icon": "smart/icon/baydffaa6539efg/a6cdd065abcde3bfb689152eda***.png",
            "lon": "20.0641",
            "time_zone": "+8.0",
            "product_name": "Robot Vacuum A001",
            "uuid": "vdevo165abcd98***",
            "active_time": 1659422574,
            "update_time": 1659422574,
            "custom_name": "Robot Vacuum in Living Room",
            "product_id": "h9soglkuugftb***",
            "name": "Robot Vacuum-vdevo",
            "id": "vdevo165abcd98***",
            "is_online": true,
            "category": "cz",
            "lat": "50.3029"
        }
    ],
    "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