简体中文
简体中文
English
联系我们
注册
登录

获取设备列表

更新时间:2022-10-14 01:23:50

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

接口描述

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

接口地址

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

请求参数

参数名类型参数位置是否必填说明
source_typeStringqueryfalse包含不同维度的设备。
  • asset:行业资产维度的设备。默认值为 asset
  • homeApp:家庭体系下 App 小程序维度关联的设备。
  • tuyaUser:涂鸦智能账号维度设备。
  • product:产品维度关联的设备。
source_idStringqueryfalsesource_type 不同时传对应的业务 ID。
  • asset 维度时传资产 ID。
  • homeApp 维度时传递 Schema。
  • tuyaUser 维度时传递 UID。
  • product 维度时传递产品 ID。
device_idsStringqueryfalse设备 ID,最多 20 个。
nameStringqueryfalse设备名称。
categoryStringqueryfalse产品品类。
product_idStringqueryfalse产品 ID。
last_row_keyStringqueryfalse上一页返回的分页标识。
page_sizeIntegerqueryfalse分页页面大小,默认 20,最大 200

返回参数

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

result 说明

参数名类型说明
has_moreBoolean是否有下一页。
listList返回数据列表。
last_row_keyString上一页的主键标识。
totalLong符合条件的数据总条数。

list 说明

参数名类型说明
idString设备 ID。
gateway_idString网关 ID, 非网关子设备时为空。
node_idString节点 ID, 非网关子设备时为空。
uuidString设备 UUID。
categoryString产品品类。
category_nameString产品品类名称。
nameString设备名称。
product_idString产品 ID。
product_nameString产品名称。
local_keyString密钥。
subBoolean是否为子设备。
asset_idString资产 ID。
owner_idString家庭 ID。
ipString设备 IP 地址。
lonString经度。
latString纬度。
modelString产品型号。
time_zoneString时区。
active_timeLong激活时间。
update_timeLong更新时间。
create_timeLong初次配网时间。
onlineBoolean在线状态。
iconString设备图标。

请求示例

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
}

错误码

参考 错误码