智慧服务，成就美好体验 项目咨询

主页 > 服务与支持 > 开发平台 > 服务端API参考 > 硬终端管理 分页查询终端

入门使用

分页查询终端

更新时间：2019-11-20

描述

企业管理员通过该接口分页查询终端信息。

接口原型

表1 接口原型

请求方法

POST

请求地址

/rest/usg/datacenter/v1/corp/device/search

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

Authorization

是

String

Header

授权令牌。将执行鉴权响应的accessToken

进行Base64转码操作。

样例：Basic Base64(accessToken)

model

否

String

Body

终端型号，枚举类型。当前支持TE系列硬件终端，具体的终端类型可以通过获取所有终端类型接口查询。

长度：0-128。

deptCode

否

String

Body

部门编号，默认为根部门。

长度：0-32。

enableSubDept

否

Boolean

Body

是否查询子部门。

默认值：true

condition

否

String

Body

查询条件包括：

  • 名称
  • 号码
  • 序列号

长度：0-64。

pageIndex

否

String

Body

页面起始页。

默认值： 1

pageSize

否

Integer

Body

可查询页面数量。

默认值：10

范围：1-1000。

响应参数

表3 参数说明

参数

类型

描述

returnCode

String

业务返回码。

returnMessage

String

返回描述。

achievementTime

String

响应产生时间。

requestId

String

请求唯一标识。

data

QueryDevicePage

分页查询信息。
表4 QueryDevicePage数据结构

参数

类型

描述

pageIndex

Integer

页面起始页。

pageSize

Integer

页面大小。

totalCount

Integer

总数量。

data

QueryDeviceResultDTO[0..*]

终端信息列表。

请求消息示例

POST /rest/usg/datacenter/v1/corp/device/search 
Connection: keep-alive
Authorization: Basic TEFqd1BJdmJhQVlrd0R2eHZ3enJNaGY5MWVMbjRIZEdK
Content-Type: application/json
Content-Length: 119
Host: api.meeting.huaweicloud.com 
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)

{
    "condition": "",
    "pageIndex": 1,
    "pageSize": 10,
    "deptCode": "dA5",
    "model": "",
    "enableSubDept": true
}
 

响应消息示例

HTTP/1.1 200 
Date: Tue, 16 Apr 2019 06:08:56 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 481
Connection: keep-alive
Pragma: No-cache
Cache-Control: no-cache
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Server: api-gateway
X-Request-Id: 3df9b4a1b0f8e77050d27a858add946c 

{
    "returnCode": "000000000",
    "returnMessage": "Success",
    "achievementTime": "2019-04-16 06:07:38.490",
    "requestId": "3df9b4a1b0f8e77050d27a858add946c",
    "data": {
        "pageIndex": 1,
        "totalCount": 1,
        "pageSize": 10,
        "data": [{
            "name": "user006",
            "type": "3rd",
            "model": "SX20",
            "sn": "GFF4WLAOAOPWXLZ2BK5C",
            "number": "+8657*******",
            "deptCode": "dA5",
            "deptName": "user001",
            "deptNamePath": "user001#user006",
            "phone": null,
            "country": null,
            "email": "test@huawei.com",
            "description": null,
            "status": 0
        }]
    }
}
 

CURL命令示例

curl -k -i -H 'content-type: application/json' -X POST -H 'Authorization:Basic T3IxeXdMUGwzeU9Gb3JnWENNWWZldnBHM0JTQVA5N2FS' -d '{"condition": "","pageIndex": 1,"pageSize": 10,"deptCode": "dA5","model": "","enableSubDept": true} 'https://api.meeting.huaweicloud.com/rest/usg/datacenter/v1/corp/device/search