查询设备列表

本文档描述如何查找应用中特定的设备。

请求 URL

POST {base_url}/device/openapi/v1.0/devices/search

请求参数

表 1. 头部参数
参数 是否必填 类型 描述
Authorization 是 String API调用的有效访问token。

格式为 Bearer {access_token}。
表 2. 主体参数
参数 是否必填 类型 描述
pageSize 是 Integer 每页显示多少条记录。
pageNumber 是 Integer

显示某一页。
sorts 否 Array 定义排序字段和显示顺序。
direction 否 String 定义显示顺序

有效值:

  • asc: 升序排列
  • desc: 降序排列
property 否 String 定义排序字段。

有效值:现有字段设备详细的现有字段.
keyword 否 String 指定要查找的关键字。
sn 否 String 指定要查找的设备序列号（SN）。
devEUI 否 String 指定要查找的设备EUI（扩展唯一标识符）。
imei 否 String 指定要查找的设备IMEI。
autopStatus 否 Array 指定要查找的设备自动配置状态。

有效值:

  • SUCCESS: 成功自动配置的设备。
  • WAITING: 等待自动配置的设备。
  • DISABLE: 禁用自动配置的设备
connectStatus 否 Array 指定要查找设备的连接状态

有效值:

  • ONLINE:主动连接到星纵物联开放平台的设备。
  • OFFLINE: 当前未连接到星纵物联开放平台的设备。
  • DISCONNECT: 星纵物联开放平台断开连接的设备。
name 否 String 指定要查找的设备名称。
model 否 String 指定要查找的设备型号。
hardwareVersion 否 String 指定要查找设备的硬件版本。
firmwareVersion 否 String 指定要查找设备的固件版本。
electricityMin 否 Integer 指定要查找的最小电池电量水平。

例如，如果把参数设置为 80，则显示电池电量超过80%的设备。
electricityMax 否 Integer 指定要查找的最大电池电量水平。

例如，如果将此参数设置为 5，则显示电池电量低于5%的设备。

提示： 您可以设置一个低电池阈值，然后使用此参数来过滤掉电池电量低的设备。
project 否 String 指定要查找的设备标签。
description 否 String 指定要查找的设备描述。

请求参数

参数 类型 描述
data Object<Search_Result> 查找结果
status String API的请求结果。
  • Success
  • Failed
requestId String 唯一的请求ID ,可用于快速定位请求。
查找结果
参数 类型 描述
pageSize Integer 每页显示的记录数。
pageNumber Integer 显示的页数。
total Integer 总记录数。
content Array<Device_Details> 符合查找条件设备的详细信息。
设备详情
参数 类型 描述
sn String 设备的序列号（SN）。
imei String 设备的IMEI（国际移动身份验证码）。
autopStatus String 设备的自动配置状态。
  • SUCCESS: 设备已成功进行了自动配置。
  • WAITING: 设备正在等待进行自动配置。
  • DISABLE: 设备自动配置已禁用。
name String 设备名称。
model String 设备型号。
hardwareVersion String 设备硬件版本。
firmwareVersion String 设备固件版本。
electricity Integer 设备电池电量水平。
lastUpdateTime Integer 设备最近一次报告的时间戳。
application Object 与设备关联的应用信息。
applicationId Integer 应用信息的唯一标识符。
applicationName String 应用信息的名称。
project String 设备标签。
description String 设备描述。
deviceId Integer 设备的唯一标识符。
devEUI String 设备的EUI（扩展唯一标识符）。
connectStatus String 设备的连接状态。
  • ONLINE: 设备已经成功连接到星纵物联开放平台。
  • OFFLINE: 设备目前未连接到星纵物联开放平台。
  • DISCONNECT: 设备已从星纵物联开放平台断开。

示例

请求示例
查找自动配置状态被禁用的设备。
POST /device/openapi/{{apiVersion}}/devices/search HTTP/1.1
Host: milesight.demo.com
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6InllYXN0b25lLWRlZmF1bHQta2V5LWlkIn0.eyJncmFudF90eXBlIjoiY2xpZW50X2NyZWRlbnRpYWxzIiwic2NvcGUiOlsib3BlbmFwaSJdLCJjbGllbnRfZXh0Ijp7ImFwcF9pZCI6IjE3MzY5NTQ4MDE3MTMzMjgxMzAifSwiZXhwIjoxNzAzMjEzMDk4LCJhdXRob3JpdGllcyI6WyJST0xFX0NMSUVOVCJdLCJqdGkiOiJiYjJjN2U4Yy03NGQwLTQ4NjEtODE3MS1iYTc0NWRlMGY0NmQiLCJjbGllbnRfaWQiOiI4OTNkNzdjNy1mMGNiLTRmMzQtOWNhMS03YzJhNGNmMTEzNDgiLCJ0cyI6MTcwMzIwOTQ5ODMzNH0
Content-Type: application/json
User-Agent: OpenAPI

{
    "pageSize": 2,
    "pageNumber": 1,
    "autopStatus": [
        "DISABLE"
    ]
}
响应示例
HTTP/1.1 200 OK
{
    "data": {
        "pageSize": 2,
        "pageNumber": 1,
        "total": 2,
        "content": [
            {
                "sn": "6785C3807364xxxx",
                "autopStatus": "DISABLE",
                "name": "Comfort Sensor Room-3D",
                "model": "AM308",
                "application": {
                    "applicationId": "1734475086466600962",
                    "applicationName": "Demo"
                },
                "project": "Workplace",
                "description": "Comfort Sensor of Room-3D",
                "deviceId": "1742010610312101890",
                "devEUI": "24E124785C38xxxx",
                "connectStatus": "DISCONNECT"
            },
            {
                "sn": "6791D1970467xxxx",
                "autopStatus": "DISABLE",
                "name": "Demo Device",
                "model": "TH-Motion Sensor",
                "hardwareVersion": "v1.0",
                "firmwareVersion": "v1.1",
                "electricity": 97,
                "lastUpdateTime": 1704180118083,
                "application": {
                    "applicationId": "1734475086466600962",
                    "applicationName": "Demo"
                },
                "project": "Workspace",
                "description": "TH-Motion Sensor of Room 4A",
                "deviceId": "1739930666380779522",
                "devEUI": "24E124791D19xxxx",
                "connectStatus": "ONLINE"
            }
        ]
    },
    "status": "Success",
    "requestId": "63abfe424fa8c7d273e36d74d87b56b0"
}