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

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

入门使用

查询终端详情

更新时间:2019-11-20

描述

企业管理员通过该接口查询终端详情。

接口原型

表1 接口原型

请求方法

GET

请求地址

/rest/usg/datacenter/v1/corp/device/{sn}

传输协议

HTTPS

请求参数

表2 参数说明

参数

是否必须

类型

位置

描述

Authorization

String

Header

授权令牌。将执行鉴权响应的accessToken进行Base64转码操作

样例:Basic Base64(accessToken)

sn

String

URL

终端SN号,仅可包含数字、字母和下划线。

长度:1-30。

响应参数

表3 参数说明

参数

类型

描述

returnCode

String

业务返回码。

returnMessage

String

返回描述。

achievementTime

String

响应产生时间。

requestId

String

请求唯一标识。

data

QueryDeviceResultDTO

终端详情。

表4 QueryDeviceResultDTO数据结构

参数

类型

描述

name

String

终端名称,建议为具体位置。

type

String

终端类型,区分自研和第三方终端。

model

String

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

sn

String

终端SN号,仅可包含数字、字母和下划线。

number

String

终端绑定的号码。

prjCodeMode

Integer

投影码生成模式。

  • 0:自动

    该模式下根据消息上报的IP地址内部控制复杂度。私网地址配置成简单模式,公网地址配置成复杂模式。

  • 1:简单
  • 2:复杂

deptCode

String

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

deptName

String

部门名称,方便前台显示。

deptNamePath

String

部门名称路径,方便前台显示。

phone

String

手机号。

country

String

手机号所属的国家

email

String

统一邮箱格式。

description

String

终端描述。

status

Integer

终端状态。

  • 0:正常
  • 1:冻结

请求消息示例

GET /rest/usg/datacenter/v1/corp/device/RDRIB8RV26YERQMVM
Connection: keep-alive
Authorization: Basic UXJ0SFVvcFgyTGdYYzVZam5TeXhOV1M2OVRXRnVDSzlX
Host: api.meeting.huaweicloud.com 
User-Agent: Apache-HttpClient/4.5.3 (Java/1.8.0_191)
 

响应消息示例

HTTP/1.1 200 
Date: Tue, 16 Apr 2019 06:19:38 GMT
Content-Type: application/json;charset=UTF-8
Content-Length: 407
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: efa03c0b6cb71b96129744f5a1a8a736 

{
    "returnCode": "000000000",
    "returnMessage": "Success",
    "achievementTime": "2019-04-16 06:18:20.473",
    "requestId": "efa03c0b6cb71b96129744f5a1a8a736",
    "data": {
        "name": "test2",
        "type": "3rd",
        "model": "SX20",
        "sn": "RDRIB8RV26YERQMVMU67",
        "number": "+8657*******",
        "deptCode": "1",
        "deptName": "user002",
        "deptNamePath": "user002",
        "phone": null,
        "country": null,
        "email": "test@huawei.com",
        "description": "test",
        "status": 0
    }
}
 

CURL命令示例

curl -k -i -X GET -H 'Authorization:Basic T3IxeXdMUGwzeU9Gb3JnWENNWWZldnBHM0JTQVA5N2FS' https://api.meeting.huaweicloud.com/rest/usg/datacenter/v1/corp/device/RDRIB8RV26YERQMVM