目录

获取设备列表

功能介绍

应用服务器向华为HEM服务器调用该接口获取指定批次设备列表。

场景描述

开发者根据设备批次获取设备列表。

使用约束

无。

接口原型

承载协议

HTTPS+POST+JSON

接口方向

EMM厂商服务端->行业解决方案服务端

接口URL

POST https://hemapi-drcn.cloud.huawei.com/hds/v1/customer/emm/device/list

数据格式

请求消息:Content-Type: application/json

响应消息:Content-Type: application/json

请求参数

参数名称

类型

必须

长度

描述信息

deviceBatchId

String

M

32

批次ID

pageNum

Integer

O

11

页码,取值范围:pageNum >0 , 默认值1

pageSize

Integer

O

11

单页数量,取值范围0<pageSize<=100,默认值10

sortBy

String

O

64

枚举:[createdTime|mdmStrategy|deployStatus], 默认值:createdTime

sortOrder

String

O

32

枚举:[desc、asc] 默认:desc

响应参数

Response Header

参数

参数类型

是否必选

描述

Content-Type

String

是

取值为:application/json; charset=UTF-8

Response Body

参数名称

类型

必须

长度

描述信息

rtnCode

Integer

M

11

响应码

rtnMsg

String

M

32

响应描述

rtnDesc

String

O

255

失败描述

result

Device[]

M

  

设备信息列表

pageNum

Integer

M

11

页码

pageSize

Integer

M

11

单页数量

totalPages

Integer

M

11

分页总数

totalCount

Integer

M

11

检索到的设备总数

返回码

返回值

备注

0

成功

85300001

参数不合法

85300004

未授权

85320001

组织用户不存在

85320002

组织用户未认证

85320003

组织用户状态异常

85330001

设备不存在

报文样例

项目

示例

请求地址

https://hemapi-drcn.cloud.huawei.com/hds/v1/customer/emm/device/list

请求报文

{"deviceBatchId": "4538689e1cd52157439ac8631a92152e"}

响应报文

{

"rtnCode": 0,

"rtnMsg": "Success",

"result": [

{

"deviceBatchId": "890469640604498176",

"serialNumber": "ZYTESTDevice1117",

"model": "ZYDEV",

"createdTime": 1652424253000,

"profileName": "1部署策略",

"projectId": "890289101670988032",

"projectName": "多sn项目测试",

"deployStatus": "ASSIGNED",

"isOperatorCancelDeploy": false,

"projectDeviceType": 1,

"deviceSource": 1,

"activeStatus": 2

},

{

"deviceBatchId": "890469640604498176",

"serialNumber": "ZYTESTDevice1034",

"model": "ZYDEV",

"createdTime": 1652424253000,

"profileName": "1部署策略",

"projectId": "890289101670988032",

"projectName": "多sn项目测试",

"deployStatus": "ASSIGNED",

"isOperatorCancelDeploy": false,

"projectDeviceType": 1,

"deviceSource": 1,

"activeStatus": 2

}

],

"pageNum": 1,

"pageSize": 10,

"totalPages": 103,

"totalCount": 1025

}

Postman在线调试

您可以使用Postman在线调试此接口。