查询项目下设备列表

更新时间:2024-07-03 07:34:31下载pdf

本文介绍查询项目下设备列表的 API。

接口描述

查看云项目下的设备列表,可根据产品 ID 和品类来筛选设备列表。

接口地址

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

请求参数

参数名类型参数位置是否必填说明
product_idsStringqueryfalse产品 ID 列表,以英文逗号分隔,不超过 5 个。
categoriesStringqueryfalse设备的产品品类列表,以英文逗号分隔,不超过 5 个。
last_idStringqueryfalse上一页返回的最后一个设备 ID,第一页不传。
page_sizeIntegerquerytrue分页页面大小,最大 20。

返回参数

参数名类型说明
resultList返回数据集。
successBoolean操作是否成功。
  • true:操作成功。
  • false:操作失败。
tLong时间戳。
tidString链路 ID。

result 说明

参数名类型说明
idString设备 ID。
categoryString设备的产品品类。
iconString设备的图标。
ipString设备的 IP 地址。
latString设备的纬度。
lonString设备的经度。
nameString设备的名称。
subBoolean是否为子设备。
uuidString设备的通用唯一识别码(UUID)。
activeTimeLong设备的激活时间戳,单位是秒。
createTimeLong设备的初次配网时间戳,单位是秒。
updateTimeLong设备的更新时间戳,单位是秒。
customNameString设备的自定义名称。
isOnlineBoolean设备是否在线。
localKeyString设备的局域网加密后的唯一密钥。
productIdString设备的产品 ID。
productNameString设备的产品名称。
timeZoneString设备的时区。

请求示例

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

返回示例

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

错误码

参考 错误码

调用频率限制

参考 调用频率限制