分页查询符合条件的设备集合

请求参数

Query 参数

project

string

可选

项目id或者项目编码。可由实施提供或者通过项目列表接口获取(http://aiot.docs.chn-das.com/api-139664251)

默认值:

1192410229407772672

instance

string

实例

可选

Header 参数

Authorization

string

可选

默认值:

Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzZXJ2ZXIiOmZhbHNlLCJzdWIiOiIxNzQzMDg0NTg3MjY0ODE5MjAxIiwiZmxhZyI6NiwiY2xpZW50VHlwZSI6bnVsbCwidXNlcl9uYW1lIjoiMTM3NjIyMzIwMDciLCJzY29wZSI6WyJzZXZlciJdLCJuYW1lIjoiMTM3NjIyMzIwMDciLCJleHAiOjE3MjA1OTcyMzAsImp0aSI6ImE5NjIxN2NiLTBiZDUtNGE1YS1iNmMzLWY1YTVlMjY3ZDIyMSIsInRlbmFudCI6InQxNzQzMDg0NTg3Mjc3NDAyMTEzIiwiY2xpZW50X2lkIjoic3lzIn0.5UPL14t8CI7oySNuurTwkWaob9HstDEILr6bpWb16QU

Body 参数application/json

pageSize

integer <int32>

每页多少条

可选

示例值:

10

pageIndex

integer <int32>

第多少页

可选

示例值:

1

deviceId

string <string>

设备唯一id

可选

示例值:

14

deviceIds

array[string]

设备id集合

可选

示例值:

sfmvro,rtgqec

deviceName

string <string>

设备名称

可选

示例值:

alonso.macejkovic

onlineState

integer <int32>

可选

在线状态 0:未激活 1:在线 2:离线 3:已停用

示例值:

3

runningState

integer <int32>

可选

启停状态 0:停用 1:启用

示例值:

3

parentState

integer <int32>

可选

设备类型（传任意值为查询子设备）

示例值:

3

parentId

string <string>

父节id

可选

示例值:

14

productId

string <string>

产品id

可选

示例值:

14

tagKey

string <string>

标签key

可选

示例值:

cqrvzg

tagValue

string <string>

标签值

可选

示例值:

d197wz

groupId

string <string>

群组id

可选

示例值:

14

exclude

boolean

可选

是否排除 (true：排除 false：不排除)

示例值:

true

sort

boolean

可选

排序（false：倒序，true：正序）

示例值:

true

excludeDeviceIdList

array[string]

排除的设备ID集合

可选

示例值:

4f0noa,j6rwrv

productIdList

array[string]

产品id集合

可选

示例值:

zymq13,anxx26

exsitDeviceIdList

array[string]

存在的设备ID集合

可选

示例值:

whu89d,byxxgy

simulator

boolean

是否模拟器查询

可选

示例值:

true

firmwareVersions

array[string]

固件版本

可选

示例值:

rqckw7,yao26s

softwareVertions

array[string]

软件版本

可选

示例值:

d6nbju,64ezhu

deviceNameOrDeviceId

string <string>

可选

设备名称/设备Id查询

示例值:

14

示例

{
  "pageSize": "10",
  "pageIndex": "1",
  "deviceId": "14",
  "deviceIds": "sfmvro,rtgqec",
  "deviceName": "alonso.macejkovic",
  "onlineState": "3",
  "runningState": "3",
  "parentState": "3",
  "parentId": "14",
  "productId": "14",
  "tagKey": "cqrvzg",
  "tagValue": "d197wz",
  "groupId": "14",
  "exclude": "true",
  "sort": "true",
  "excludeDeviceIdList": "4f0noa,j6rwrv",
  "productIdList": "zymq13,anxx26",
  "exsitDeviceIdList": "whu89d,byxxgy",
  "simulator": "true",
  "firmwareVersions": "rqckw7,yao26s",
  "softwareVertions": "d6nbju,64ezhu",
  "deviceNameOrDeviceId": "14"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'http://prod-cn.your-api-server.com/api/open/iot-device/devicemanage/v1/device/page?project=1192410229407772672&instance=' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzZXJ2ZXIiOmZhbHNlLCJzdWIiOiIxNzQzMDg0NTg3MjY0ODE5MjAxIiwiZmxhZyI6NiwiY2xpZW50VHlwZSI6bnVsbCwidXNlcl9uYW1lIjoiMTM3NjIyMzIwMDciLCJzY29wZSI6WyJzZXZlciJdLCJuYW1lIjoiMTM3NjIyMzIwMDciLCJleHAiOjE3MjA1OTcyMzAsImp0aSI6ImE5NjIxN2NiLTBiZDUtNGE1YS1iNmMzLWY1YTVlMjY3ZDIyMSIsInRlbmFudCI6InQxNzQzMDg0NTg3Mjc3NDAyMTEzIiwiY2xpZW50X2lkIjoic3lzIn0.5UPL14t8CI7oySNuurTwkWaob9HstDEILr6bpWb16QU' \
--header 'Content-Type: application/json' \
--data-raw ''

返回响应

🟢200OK

application/json

Body

pageIndex

number <int64>

当前页

可选

示例值:

200

pageSize

number <int64>

每页记录数

可选

示例值:

402

totalCount

number <int64>

总记录数

可选

示例值:

727

totalPage

number <int64>

总页数

可选

示例值:

501

data

array[object (DeviceDetail) {17}]

数据

可选

示例值:

deviceId

string

设备编码

必需

deviceName

string

设备名称

必需

productId

string

产品编码

必需

productName

string

产品名称

必需

deviceSecretKey

string

设备密钥

必需

nodeType

string

节点类型

必需

direct-device:直连设备 gateway-device:网关设备 gateway-sub-device:网关子设备

onlineState

number

在线状态

必需

0:未激活 1:在线 2:离线 3:已停用

runningState

number

启停状态

必需

0:停用 1:启用

description

string

设备描述

必需

authType

string

认证类型

必需

0：SECRET密钥认证，1：CERTIFICATE证书认证

fingerprint

string

设备证书对应的指纹

可选

firmwareVersion

string

固件版本

可选

softwareVersion

string

软件版本

可选

timezone

string

时区

必需

默认 Asia/Shanghai

extraData

string

额外数据

可选

activationTime

string

激活时间

必需

13位时间戳

creationTime

string

创建时间

必需

13位时间戳

示例

{
  "pageIndex": "200",
  "pageSize": "402",
  "totalCount": "727",
  "totalPage": "501",
  "data": ""
}