用户根据设备ID查询设备信息详情

功能介绍

用户根据设备ID查询设备信息详情

URI

GET /v1/{user_id}/devices/{device_id}

表1 路径参数
参数	是否必选	参数类型	描述
device_id	是	String	设备ID：好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR），用来区分设备类型
user_id	是	String	用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节

请求参数

表2 请求Header参数
参数	是否必选	参数类型	描述
Access-Token	是	String	用户认证AccessToken：从获取用户北向接口认证AccessToken中获取

表3 Query参数
参数	是否必选	参数类型	描述
ability	否	Array of strings	查询的能力集列表：不传默认查询所有能力集，数组长度范围[0,10]。能力集对应能力参考设备能力集。
need_cloud_ability	否	Boolean	是否需要返回云上管理的能力集：false，不返回云上能力集信息；true，返回云上能力集信息。不填默认false
need_specification	否	Boolean	是否需要能力规格：false，不返回能力规格；true，返回能力规格。不填默认false

响应参数

状态码： 200

表4 响应Body参数
参数	参数类型	描述
mac	String	设备mac地址
device_id	String	设备ID，设备唯一标识符，如：2102412969WLMB002258
device_name	String	设备名称
device_state	String	设备状态枚举值： OFFLINE 离线 ONLINE 在线 UNREGISTERED 未注册
access_protocol	String	接入类型枚举值： GB28181 国标 HOLO 好望
device_type	String	设备类型枚举值： IPC 通用相机 NVR NVR设备 MEdge IVS1800设备 IPC-BULLET枪机 IPC-BOX筒机 IPC-CONCH 半球/海螺 IPDOME球机
device_system_state	String	设备系统冻结枚举值： NORMAL 正常 UNAVAILABLE_FROZEN 冻结
description	String	设备描述
model	String	设备型号，如：D2150
manufacture	String	生产厂商，如：HUAWEI
channel_total	Integer	通道总数
stream_total	Integer	每个通道码流数量
firmware	String	摄像头固件版本号
device_ability	String	设备能力集：枚举类型，参考附录设备能力集，多个能力集用逗号分隔
device_cloud_ability	Object	云端能力集规格
create_time	String	创建时间
update_time	String	更新时间，在设备重新上线后或者移动设备分组后会修改时间
protocol_version	String	设备与平台接入协议版本，如：2.0.0
device_ip	String	设备IP
device_port	String	设备端口
device_org_id	String	设备组织ID
sn	String	SN号，等于device_id——设备ID，设备唯一标识符
device_org_name	String	设备所处的设备组织名称
operator_total	String	操作员总数
sdk_ability	String	sdk能力集

请求示例

租户根据设备ID查询设备

GET /v1/2562572829***/devices/952352LWXT***?need_cloud_ability=true

响应示例

状态码： 200

{
  "device_id": "952352LWXT***",
  "device_name": "测试设备",
  "device_state": "ONLINE",
  "access_protocol": "HOLO",
  "device_type": "IPC",
  "device_system_state": "NORMAL",
  "description": "test",
  "model": "JVS-N71-HD",
  "manufacture": "JOVISION",
  "channel_total": 10,
  "stream_total": 2,
  "firmware": "V1.0",
  "device_ability" : "ptz,talk",
  "device_cloud_ability": {
    "alarm_voice": {
      "support": "true"
    }},
  "create_time": "2020-06-26 20:42:16",
  "update_time": "2020-06-26 20:42:16",
  "protocol_version": "2.0.0",
  "mac": "xxx",
  "device_ip": "xxx.xxx.xxx.xxx",
  "device_port": "8090",
  "device_org_id": "1234567890***",
  "device_org_name": "测试组织***",
  "operator_total": "2",
  "sdk_ability": "***",
  "sn": "952352LWXT***"
}