查询空间下设备列表

更新时间:2023-11-23 06:45:08下载pdf

本文介绍查询空间下设备列表的 API。

接口描述

根据空间 ID 列表、是否递归子空间、产品 ID 列表和产品品类列表,分页查询空间下设备列表。

接口地址

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

请求参数

参数名类型参数位置是否必填说明
space_idsStringquerytrue空间 ID 列表,以英文逗号分隔,不超过 5 个。本参数不能为空。
is_recursionBooleanqueryfalse是否递归子空间。
  • true:递归子空间查询设备详情。
  • false 或者不传:不递归,只查询当前空间下设备。
product_idsStringqueryfalse产品 ID 列表,以英文逗号分隔,不超过 5 个。
categoriesStringqueryfalse设备的产品品类列表,以英文逗号分隔,不超过 5 个。
last_idStringqueryfalse上一页返回的最后一个设备 ID,第一页不传。
page_sizeIntegerquerytrue分页页面大小,最大 20。

返回参数

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

result 说明

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

请求示例

GET: /v2.0/cloud/thing/space/device?space_ids=146323341***

返回示例

{
    "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": "扫地机A001",
            "uuid": "vdevo165abcd98***",
            "active_time": 1659422574,
            "update_time": 1659422574,
            "custom_name": "客厅扫地机",
            "product_id": "h9soglkuugftb***",
            "name": "扫地机-vdevo",
            "id": "vdevo165abcd98***",
            "is_online": true,
            "category": "cz",
            "lat": "50.3029"
        }
    ],
    "t": 1677752774750,
    "success": true
}

错误码

参考 错误码

调用频率限制

参考 调用频率限制