获取设备列表

更新时间：2023-06-20 15:22:52下载pdf

本文介绍获取设备列表的 API。

接口描述

获取项目下符合条件的设备列表。

接口地址

GET: /v1.3/iot-03/devices

请求参数

参数名	类型	参数位置	是否必填	说明
source_type	String	query	false	包含不同维度的设备。 `asset`：行业资产维度的设备。默认值为 `asset`。 `homeApp`：家庭体系下 App 小程序维度关联的设备。 `tuyaUser`：涂鸦智能账号维度设备。 `product`：产品维度关联的设备。
source_id	String	query	false	在 `source_type` 不同时传对应的业务 ID。 `asset` 维度时传资产 ID。 `homeApp` 维度时传递 Schema。 `tuyaUser` 维度时传递 UID。 `product` 维度时传递产品 ID。
device_ids	String	query	false	设备 ID，最多 20 个。
name	String	query	false	设备名称。
category	String	query	false	产品品类。
product_id	String	query	false	产品 ID。
last_row_key	String	query	false	上一页返回的分页标识。
page_size	Integer	query	false	分页页面大小，默认 `20`，最大 `200`。

返回参数

参数名	类型	说明
result	CursorPage	返回结果。

result 说明

参数名	类型	说明
has_more	Boolean	是否有下一页。
list	List	返回数据列表。
last_row_key	String	上一页的主键标识。
total	Long	符合条件的数据总条数。

list 说明

参数名	类型	说明
id	String	设备 ID。
gateway_id	String	网关 ID, 非网关子设备时为空。
node_id	String	节点 ID, 非网关子设备时为空。
uuid	String	设备 UUID。
category	String	产品品类。
category_name	String	产品品类名称。
name	String	设备名称。
product_id	String	产品 ID。
product_name	String	产品名称。
local_key	String	密钥。
sub	Boolean	是否为子设备。
asset_id	String	资产 ID。
owner_id	String	家庭 ID。
ip	String	设备 IP 地址。
lon	String	经度。
lat	String	纬度。
model	String	产品型号。
time_zone	String	时区。
active_time	Long	激活时间。
update_time	Long	更新时间。
create_time	Long	初次配网时间。
online	Boolean	在线状态。
icon	String	设备图标。

请求示例

GET: /v1.3/iot-03/devices?category=xx&product_id=xx&name=xx&device_ids=xx&last_row_key=xx&page_size=xx

返回示例

{
    "result": {
        "last_row_key": "B4C4EBD263D95628587B9643840E****",
        "list": [
            {
                "sub": false,
                "category_name": "光源",
                "create_time": 1567395627,
                "local_key": "8ab649951d59****",
                "owner_id": "3125****",
                "ip": "124.90.34.***",
                "icon": "smart/icon/1526276264k8q8l44swr2ennf6zx5u92***_0.png",
                "lon": "120.0***",
                "time_zone": "+08:00",
                "product_name": "灯",
                "uuid": "38042025cc50e325****",
                "gateway_id": "",
                "active_time": 1620299529,
                "update_time": 1635939139,
                "product_id": "ylr9R01cMWnM****",
                "name": "灯",
                "online": false,
                "model": "LE7",
                "id": "38042025cc50e325****",
                "category": "dj",
                "lat": "30.3***"
            }
        ],
        "total": 34,
        "has_more": true
    },
    "t": 1635940989216,
    "success": true
}

错误码

参考错误码。