获取端设备列表

请求参数

Header 参数

Authorization-Type

string

必需

默认值:

X-Authorization

string

必需

默认值:

Body 参数application/json

unPage

boolean | null

禁用分页

可选

默认值:

false

pageSize

integer | null

页内条目数

可选

默认值:

10

pageNumber

integer | null

页码

可选

默认值:

1

sorting

string | null

排序字段名

可选

示例值:

creationTime

sortingDirection

enum<string> | enum<null>

排序方向

可选

枚举值:

ASCDESC

默认值:

ASC

ids

array[string | null] | null

设备ID

可选

deviceName

string | null

设备SN

可选

deviceNames

array[string] | null

设备SN列表

可选

productKeys

array[string] | null

产品标识

可选

deviceStatus

enum<string> | enum<null>

设备状态

可选

枚举值:

ONLINEOFFLINEUNREGISTER

areaCodes

array[string] | null

区域编码

可选

description

string | null

设备描述

可选

deviceNo

string | null

设备编号

可选

deviceModelCode

string | null

设备型号

可选

ip

string | null

设备IP

可选

pmsId

string | null

PMSID

可选

protocolType

enum<string> | enum<null>

协议类型

可选

枚举值:

UT_IOTIEC104

governUnitCode

string | null

管辖单位

可选

deviceManufacturerCode

string | null

设备厂家

可选

startTime

integer | null

创建设备左闭区间

可选

秒时间戳

endTime

integer | null

创建设备右闭区间

可选

秒时间戳

serviceStatus

enum<string>

投运状态

可选

枚举值:

ONOFF

serviceStatusOnTime

integer

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://iot-dev.utapp.cn/api/v2/device/getEndDeviceList' \
--header 'Authorization-Type;' \
--header 'X-Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "parentId": "kFUE1BN-rgs",
  "childName": "",
  "pageNumber": 3,
  "pageSize": 10
}'

返回响应

🟢200成功

application/json

Body

code

integer

响应代码

必需

0代表成功，1代表业务异常，其他数字看具体情况

示例值:

0

message

string

响应消息

必需

接口异常时，异常信息于此字段

示例值:

操作成功

data

object

响应数据

必需

接口数据于此字段

totalCount

integer

总数

必需

items

array [object {26}]

数据条目

必需

success

boolean

是否成功

必需

true=接口响应成功，false=接口响应异常

默认值:

true

示例

{
    "code": 0,
    "message": "操作成功",
    "data": {
        "totalCount": 0,
        "items": [
            {
                "id": "string",
                "name": "string",
                "description": "string",
                "dataTopology": "NORMAL",
                "productKey": "string",
                "productName": "string",
                "active": "false",
                "registered": "false",
                "lastActivityTime": 0,
                "deviceNo": "string",
                "deviceModelCode": "string",
                "pmsId": "string",
                "governUnitCode": "string",
                "deviceManufacturerCode": "string",
                "deviceManufacturerName": "string",
                "deviceManufacturerSimpleName": "string",
                "ip": "string",
                "protocolType": "string",
                "createTime": 0,
                "isBind": true,
                "bindTime": "string",
                "serviceStatus": "ON",
                "feature": "PhotoVoltaic",
                "parentId": "string",
                "parentName": "string",
                "parentDesc": "string"
            }
        ]
    },
    "success": "true"
}