文档首页/ 行业视频管理服务 IVM/ API参考/ 通道管理/ 查询通道详情
更新时间：2024-05-21 GMT+08:00
查看PDF
分享

查询通道详情

功能介绍

通过设备ID，通道ID查询通道详情

URI

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

表1 路径参数

参数

是否必选

参数类型

描述

channel_id

是

String

通道ID：

好望设备：取值范围[0,999]

国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取

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 Query参数

参数

是否必选

参数类型

描述

ability

否

Array of strings

查询的能力集列表：不传默认查询所有能力集，数组长度范围[0,10]

need_cloud_ability

否

Boolean

是否需要返回云上管理的能力集：false，不返回云上能力集信息；true，返回云上能力集信息。不填默认false

need_specification

否

Boolean

是否需要能力规格：false，不返回能力规格；true，返回能力规格。不填默认false
表3 请求Header参数

参数

是否必选

参数类型

描述

Access-Token

是

String

用户认证AccessToken：从获取用户北向接口认证AccessToken中获取

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

device_id

String

设备ID，设备唯一标识

channel_id

String

通道ID

channel_name

String

通道名称

channel_state

String

通道状态

枚举值：

  • OFFLINE 离线

  • ONLINE 在线
  • UNREGISTERED 未注册

access_protocol

String

接入协议

枚举值：

  • HOLO 好望协议

  • GB28181 国标协议

channel_system_state

String

设备系统状态

枚举值：

  • NORMAL 正常

  • UNAVAILABLE_FROZEN 冻结

channel_resource_state

Array of strings

通道资源

枚举值：

  • MANAGEMENT_GRANT 管理套餐开通

  • MANAGEMENT_ARREAR 管理套餐欠费

  • MANAGEMENT_CLOSED 管理套餐未开通

  • EVENT_RECORD_GRANT 动检套餐开通

  • EVENT_RECORD_ARREAR 动检套餐欠费

  • EVENT_RECORD_CLOSED 动检套餐关闭

  • FULL_RECORD_GRANT 全量套餐开通

  • FULL_RECORD_ARREAR 全量套餐欠费

  • FULL_RECORD_CLOSED 全量套餐关闭

  • INDUSTRY_DATA_GRANT 行业数据流套餐开通

  • INDUSTRY_DATA_ARREAR 行业数据流套餐欠费

  • INDUSTRY_DATA_CLOSED 行业数据流套餐关闭

channel_ability

String

通道能力集：枚举类型，参考附录设备能力集，多个能力集用逗号分隔

device_cloud_ability

Object

云端能力集规格

model

String

通道的设备型号，如：D3250

channel_intelligent

String

智能算法能力集

firmware

String

通道的设备固件版本号，如：SDC 10.0.0

create_time

String

通道创建时间

update_time

String

通道更新时间

sn

String

SN号

channel_firmware_id

String

通道的设备固件版本号

channel_type

String

通道类型

resolution

String

分辨率

请求示例

GET /v1/2562572829***/devices/952352DJNR***/channels/0?need_cloud_ability=true

响应示例

状态码： 200

OK 
{
  "device_id" : "952352DJNR***",
  "channel_id" : "0",
  "channel_name" : "龙岗通道1",
  "channel_state" : "ONLINE",
  "access_protocol" : "HOLO",
  "channel_system_state" : "NORMAL",
  "channel_resource_state" : [ "MANAGEMENT_GRANT", "EVENT_RECORD_CLOSED", "FULL_RECORD_CLOSED" ],
  "channel_ability" : "ptz,talk",
  "device_cloud_ability": {
    "alarm_voice": {
      "support": "true"
    }},
  "model" : "L",
  "channel_intelligent" : "[{\"name\":\"perimeter\",\"enable\":true}]",
  "firmware" : "V22",
  "channel_firmware_id": "",
  "create_time" : "2020-06-26 20:42:16.0",
  "update_time": "2023-12-05 10:09:46.0",
  "sn": "",
  "channel_type": "IPC",
  "resolution": "5/6/4"
}

状态码

请参见状态码

错误码

请参见错误码

父主题： 通道管理

相关文档