Skip to content

设备管理

GET 获取设备列表

GET /clip/v2/resource/device

说明

  • 此接口的应答中, data 为数组
  • 支持过滤, 支持以下字段:
    • cat1_id. 1 网关。2 灯。3 同步器。4 配件
    • cat1_id_not
    • join_status
    • room_uuid
    • sn
  • 支持扩展, 支持以下字段:
    • ext_light
    • ext_room

请求参数

名称位置类型必选中文名说明
cat1_idquerystring包含哪些品类的设备, 可以是多个值, 用逗号隔开
cat1_id_notquerystring不包含哪些品类的设备, 可以是多个值, 用逗号隔开
join_statusquerystring是否已经添加到网关服务中
room_uuidquerystring房间uuid
snqueryarray[string]none
ext_lightquerystringnone
ext_roomquerystringnone
ext_zigbeequerystringnone

返回示例

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "arr": [
      {
        "id": "27968061-68C1-4538-83AF-88E390FD8933",
        "type": "device",
        "name": "Bar Lamp",
        "join_status": 1,
        "online": 1,
        "has_new": 0,
        "product": {
          "cat1_id": 2,
          "cat1_name": "Light",
          "cat2_id": 205,
          "cat2_name": "RGB CW Light",
          "cat3_id": 20504,
          "cat3_name": "Bar Lamp",
          "manufacturer": "Bweetech",
          "model": "915005988001",
          "hardware_version": "6",
          "software_version": "",
          "zigbee_version": "4.8.8_46"
        },
        "services": [
          {
            "rid": "8C3C3D02-A008-44F2-9C6A-146705167EB3",
            "rtype": "light"
          }
        ]
      }
    ]
  }
}

返回结果

状态码状态码含义说明数据模型
200OKnoneInline

返回数据结构

状态码 200

名称类型必选约束中文名说明
» codeintegertruenonenone
» msgstringtruenonenone
» dataobjecttruenonenone
»» arr[DeviceDetail]truenonenone
»»» idstringtruenone设备UUIDnone
»»» typestringtruenone类型此处必然为 device
»»» namestringtruenone名称none
»»» join_statusintegertruenone入网状态一般, 需要过滤 join_status=1 的设备, 若=0, 代表不是用户想加的设备
»»» onlineintegertruenone在线状态1在线, 0离线
»»» has_newintegertruenone是否有新版本1有更新, 0无
»»» productobjecttruenone产品信息none
»»»» cat1_idintegertruenone1类id1网关, 2灯具, 3同步器
»»»» cat1_namestringtruenone1类名称none
»»»» cat2_idintegertruenone2类id分类信息, 如 203为CW灯, 205为RGBCW灯
»»»» cat2_namestringtruenone2类名称none
»»»» cat3_idintegertruenone3类id精确到产品, 如 20504 为 Bar灯
»»»» cat3_namestringtruenone3类名称none
»»»» manufacturerstringtruenone厂商信息zigbee basic cluster 中的 manufacturer
»»»» modelstringtruenone型号zigbee basic cluster 中的 model
»»»» hardware_versionstringtruenone硬件版本号none
»»»» software_versionstringtruenone软件版本号none
»»»» zigbee_versionstringtruenoneZigbee版本号none
»»» services[ResInfo]truenonenone
»»»» ridstringtruenone资源UUIDnone
»»»» rtypestringtruenone资源类型none