--- title: "获取设备列表" method: POST path: "/api/v1/things/device/info/index" tags: ["things/device/info", "thingsDeviceInfo"] --- # 获取设备列表 `POST /api/v1/things/device/info/index` ## Request body - DeviceInfoIndexReq - `areaID` string — 项目区域ids - `areaIDPath` string — 区域路径过滤 - `areaIDPaths` string[] — 区域路径过滤 - `areaIDs` string[] — 项目区域ids - `deviceAlias` string — 过滤条件:模糊查询 设备别名 - `deviceName` string — 过滤条件:模糊查询 设备名 - `deviceNameOrAlias` string — 过滤条件:模糊查询 设备名或别名 - `deviceNames` string[] — 过滤条件:精准查询 设备名 - `deviceTypes` integer[] — 设备类型:1:设备,2:网关,3:子设备设备类型:1:设备,2:网关,3:子设备 - `devices` DeviceCore[] - `deviceName` string, required — 设备名称 - `productID` string, required — 产品ID - `productName` string - `expTime` CompareInt64 - `cmpType` string, required — "=":相等 "!=":不相等 ">":大于">=":大于等于"<":小于"<=":小于等于 "like":模糊查询 - `value` string, required - `gateway` DeviceCore - `deviceName` string, required — 设备名称 - `productID` string, required — 产品ID - `productName` string - `groupID` string - `groupIDPath` string - `groupIDPaths` string[] - `groupIDs` string[] - `groupName` string - `groupPurpose` string — 设备分组用途 不填默认为default - `hasOwner` integer — 是否被人拥有,1为是 2为否 - `iccid` string — SIM卡卡号 - `isOnline` integer — 在线状态过滤 1离线 2在线 - `isOnlyCore` boolean — 只返回核心信息 - `netType` integer — 通讯方式:1:其他,2:wi-fi,3:2G/3G/4G,4:5G,5:BLE,6:LoRaWAN,7:wifi+ble,8:有线网 - `notAreaID` string - `notGroupID` string - `notVersion` string - `page` PageInfo - `orders` OrderBy[] — 排序 - `field` string — 排序的字段名 - `sort` integer — 排序方式：1 从小到大, 2 从大到小 - `page` integer — 页码 - `size` integer — 每页大小 - `parentGroupID` string - `position` Point - `latitude` number, double, required — 纬度 - `longitude` number, double, required — 经度 - `productCategoryID` integer - `productCategoryIDs` integer[] - `productID` string — 产品id 为空时获取所有产品 - `productIDs` string[] — 产品id 为空时获取所有产品 - `property` object — 设备最新属性过滤,key为属性的id,如果是结构体则key为 aaa.bbb 数组为aaa.1 - `propertyIgnoreEmpty` boolean — 设备属性是否忽略空值,空值是否返回 - `range` integer — 过滤条件:距离坐标点固定范围内的设备 单位：米 - `ratedPower` CompareInt64 - `cmpType` string, required — "=":相等 "!=":不相等 ">":大于">=":大于等于"<":小于"<=":小于等于 "like":模糊查询 - `value` string, required - `rssi` CompareInt64 - `cmpType` string, required — "=":相等 "!=":不相等 ">":大于">=":大于等于"<":小于"<=":小于等于 "like":模糊查询 - `value` string, required - `status` integer — 设备状态 1-未激活，2-在线，3-离线 4-异常(频繁上下线,告警中) - `statuses` integer[] - `tags` Tag[] — key tag过滤查询,非模糊查询 为tag的名,value为tag对应的值 - `key` string, required - `value` string, required - `tenantCode` string - `userID` string - `versions` string[] - `withArea` boolean — 同时返回区域信息 - `withCollect` integer — 过滤收藏的设备(这里只获取收藏的设备) 1: 同时获取收藏的设备 2:只获取收藏的设备 - `withGateway` boolean — 同时返回子设备绑定的网关信息 - `withGroups` string[] - `withOwner` boolean — 同时获取拥有人的信息 - `withProfiles` string[] - `withProperties` string[] — 如果不为nil,如果为空,获取设备所有最新属性 如果传了属性列表,则会返回属性列表,如果没有匹配的则不会返回 - `withShared` integer — 过滤分享的设备1: 同时获取分享的设备 2:只获取分享的设备 ## Response `200` A successful response. - object - `code` integer - `data` DeviceInfoIndexResp - `list` DeviceInfo[], required — 设备信息 - `adcode` string — 地区编码 - `address` string — 所在地址 - `area` AreaInfo - `areaID` string — 项目区域id（只读） - `areaName` string — 项目区域名称（读写） - `projectID` string — 项目id（只读） - `areaID` string — 项目区域id 只读 - `categoryID` integer — 产品品类 - `cert` string — 设备证书 只读 - `createdTime` string — 创建时间 只读 - `desc` string - `deviceAlias` string — 设备别名 读写 - `deviceImg` string — 设备图片 - `deviceName` string, required — 设备名称 读写 - `deviceType` integer — 设备类型:1:直连设备,2:网关,3:子设备,4:监控设备 - `distributor` IDPath - `id` integer - `idPath` string - `expTime` string — 到期时间 - `file` string — 设备相关文件 - `firstBind` string - `firstLogin` string — 激活时间 只读 - `gateway` DeviceInfo — recursive - `groupIDs` string[] — 如果要更新分组,必须填写groupPurpose - `groupPurpose` string — 更新的时候使用,将设备该用途下的分组进行更新 - `groups` GroupCore[] — 所在分组信息,只读 - `id` integer, required - `name` string, required - `parentID` integer, required - `purpose` string, required — 用途 - `hardInfo` string — 模组硬件型号 只读 - `iccid` string — SIM卡卡号 - `id` integer - `imei` string — IMEI号信息 只读 - `isEnable` integer — 是否启用 - `isOnline` integer — 在线状态 1离线 2在线 只读 - `isUpdateDeviceImg` boolean — 只有这个参数为true的时候才会更新设备图片,传参为设备图片的file path - `isUpdateFile` boolean — 只有这个参数为true的时候才会更新设备文件,传参为设备文件的file path - `lastBind` string — 最后绑定时间 只读 - `lastIp` string — 最后登录的ip地址 - `lastLocalIp` string — 最后登录局域网的ip地址 - `lastLogin` string — 最后上线时间 只读 - `lastOffline` string — 最后下线时间 只读 - `logLevel` integer — 日志级别:1)关闭 2)错误 3)告警 4)信息 5)调试 读写 - `mac` string — MAC号信息 只读 - `mobileOperator` integer — 移动运营商:1)移动 2)联通 3)电信 4)广电 - `needConfirmVersion` string — 待确认升级的版本 - `netType` integer — 通讯方式:1:其他,2:wi-fi,3:2G/3G/4G,4:5G,5:BLE,6:LoRaWAN,7:wifi+ble,8:有线网,9:4G+BLE - `owner` UserCore - `createdTime` string — 创建时间 - `email` string — 邮箱 - `headImg` string — 用户头像 - `lastIP` string — 最后登录ip - `nickName` string — 用户的昵称 - `phone` string — 手机号 - `regIP` string — 注册ip - `userID` string — 用户id - `userName` string — 用户名(唯一) - `phone` string — 手机号 - `position` Point - `latitude` number, double, required — 纬度 - `longitude` number, double, required — 经度 - `productID` string, required — 产品id 只读 - `productImg` string — 产品图片 - `productName` string - `profiles` object - `projectID` string — 项目id 只读 - `protocolConf` Tag[] — 协议配置 - `key` string, required - `value` string, required - `ratedPower` integer - `rssi` integer — 信号强度 - `schemaAlias` object — 设备物模型别名,如果是结构体类型则key为xxx.xxx - `secret` string — 设备秘钥 只读 - `softInfo` string — 模组软件版本 只读 - `sort` integer — 排序 - `status` integer — 设备状态 1-未激活，2-在线，3-离线 4-异常(频繁上下线,告警中) - `subProtocolConf` Tag[] — 子协议配置 - `key` string, required - `value` string, required - `tags` Tag[] — 设备tag - `key` string, required - `value` string, required - `tenantCode` string - `userID` string - `version` string — 固件版本 读写 - `withProperties` object — 获取的属性列表,如果不传withProperty,则不会返回 - `page` integer — 页码 - `pageSize` integer — 每页大小 - `total` integer - `msg` string --- [API](https://skmtc.net/unitedrhino/apis/things-api.md) · [All operations](https://skmtc.net/unitedrhino/apis/things-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/unitedrhino/things-api/versions/f3bdeb916389/schema)