v1

latestOpenAPI 3.0.32026-07-17178286472.4 KB
things/device/info
thingsDeviceInfo

获取设备列表

post/api/v1/things/device/info/index

Request body

areaIDstring

项目区域ids

areaIDPathstring

区域路径过滤

areaIDPathsstring[]

区域路径过滤

areaIDsstring[]

项目区域ids

deviceAliasstring

过滤条件:模糊查询 设备别名

deviceNamestring

过滤条件:模糊查询 设备名

deviceNameOrAliasstring

过滤条件:模糊查询 设备名或别名

deviceNamesstring[]

过滤条件:精准查询 设备名

deviceTypesinteger[]

设备类型:1:设备,2:网关,3:子设备设备类型:1:设备,2:网关,3:子设备

groupIDstring
groupIDPathstring
groupIDPathsstring[]
groupIDsstring[]
groupNamestring
groupPurposestring

设备分组用途 不填默认为default

hasOwnerinteger

是否被人拥有,1为是 2为否

iccidstring

SIM卡卡号

isOnlineinteger

在线状态过滤 1离线 2在线

isOnlyCoreboolean

只返回核心信息

netTypeinteger

通讯方式:1:其他,2:wi-fi,3:2G/3G/4G,4:5G,5:BLE,6:LoRaWAN,7:wifi+ble,8:有线网

notAreaIDstring
notGroupIDstring
notVersionstring
parentGroupIDstring
productCategoryIDinteger
productCategoryIDsinteger[]
productIDstring

产品id 为空时获取所有产品

productIDsstring[]

产品id 为空时获取所有产品

propertyobject

设备最新属性过滤,key为属性的id,如果是结构体则key为 aaa.bbb 数组为aaa.1

propertyIgnoreEmptyboolean

设备属性是否忽略空值,空值是否返回

rangeinteger

过滤条件:距离坐标点固定范围内的设备 单位:米

statusinteger

设备状态 1-未激活,2-在线,3-离线 4-异常(频繁上下线,告警中)

statusesinteger[]
tenantCodestring
userIDstring
versionsstring[]
withAreaboolean

同时返回区域信息

withCollectinteger

过滤收藏的设备(这里只获取收藏的设备) 1: 同时获取收藏的设备 2:只获取收藏的设备

withGatewayboolean

同时返回子设备绑定的网关信息

withGroupsstring[]
withOwnerboolean

同时获取拥有人的信息

withProfilesstring[]
withPropertiesstring[]

如果不为nil,如果为空,获取设备所有最新属性 如果传了属性列表,则会返回属性列表,如果没有匹配的则不会返回

withSharedinteger

过滤分享的设备1: 同时获取分享的设备 2:只获取分享的设备

Response

A successful response.

codeinteger
msgstring