云服务 API 参考设备高级服务垂直品类硬件 API行业三方设备能力公区通用能力公区设备信息获取设备列表

获取设备列表

更新时间：2023-06-20 14:54:08下载pdf

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

接口描述

根据查询条件，获取设备信息列表。

接口地址

GET: /v1.0/expand/devices

请求参数

参数名	类型	参数位置	是否必填	说明
request	DeviceQueryRequest	query	true	设备查询请求对象

request 说明

参数名	类型	是否必填	说明
project_id	String	true	项目 ID
page_no	Integer	true	分页页码
page_size	Integer	true	分页页面大小
product_type	String	false	产品品类

返回参数

参数名	类型	说明
result	PageResult	响应结果

result 说明

参数名	类型	说明
list	List	数据列表
total	Long	总数
page_size	Integer	分页页面大小
page_no	Integer	分页页码

list 说明

参数名	类型	说明
project_id	String	项目 ID
device_id	String	设备 ID
cid	String	设备硬件唯一 ID
gateway_id	String	网关 ID
device_name	String	设备名称
device_ip	String	设备 IP 地址
mac_address	String	设备 MAC 地址
product_type	String	产品品类
product_id	String	产品 ID
supplier_code	String	供应商 Code
install_location	String	安装地址
extend_data	String	扩展数据
active_status	String	设备激活状态。 `0`：未激活 `1`：已激活
online_status	String	设备在线状态。 `0`：离线 `1`：在线
create_time	Long	设备创建时间
product_name	String	产品名称
supplier_name	String	供应商名称
task_id	String	施工任务 ID

请求示例

GET: /v1.0/expand/devices?projectId=123****&pageNo=1&pageSize=20

返回示例

{
    "result": {
        "page_no": 1,
        "list": [
            {
                "device_id": "6ce****",
                "create_time": 1591693362843,
                "online_status": 1,
                "gateway_id": "6c2****",
                "install_location": "小区东入口",
                "device_ip": "192.***.16.111",
                "uid": "ay1534****",
                "device_name": "小区东入口门禁",
                "product_type": "wf_znmj",
                "extend_data": "{'pass':'123456','ip':'192.***.2.160','url':'http://192.***.2.160:8090'}",
                "active_status": 1,
                "project_id": "1356****",
                "mac_address": "00-55-52-**-**-**",
                "product_id": "0vbr****",
                "supplier_code": "tuya",
                "cid": "1207****"
            }
        ],
        "total": 100,
        "page_size": 20
    },
    "t": 1551851043862,
    "success": true
}

错误码

参考错误码。