华为云用户手册

URI GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/device-records 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度固定为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 channel_id 是 String 通道ID： 好望设备：取值范围[0,999] 国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取 表2 Query参数 参数 是否必选 参数类型 描述 start_time 是 String 开始时间：格式如：yyyy-MM-dd HHmmss end_time 是 String 结束时间：格式如：yyyy-MM-dd HHmmss limit 否 String 单页数量：取值范围[1,1000]，不填写时默认值为 10 offset 否 String 偏移量：offset为0时表示查询第一页的数据，取值范围[0,1000000]，不填写时默认值为 0

响应示例 状态码： 200 查询设备的录像列表（国标）响应 { "total" :0, "records" : [ { "record_name" : "录像1", "record_type" : "NORMAL_RECORD", "start_time" : "2020-06-12 17:31:00", "end_time" : "2020-06-16 17:31:00" } ] }

URI GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/cloud-records/playback-url 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度固定为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 channel_id 是 String 通道ID： 好望设备：取值范围[0,999] 国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取 表2 Query参数 参数 是否必选 参数类型 描述 playback_protocol 是 String 媒体播放协议：枚举类型，选择获取地址的媒体播放协议类型 枚举值： HOLO 好望协议 HLS 基于HTTP的HLS流媒体传输协议（该协议存在安全风险，建议优先使用其他协议） HLS_HTTPS 基于HTTPS的HLS流媒体传输协议 RTSP RTSP流媒体传输协议（该协议存在安全风险，建议优先使用其他协议） record_type 否 String 录像类型：枚举类型，不填则默认包含以下两种录像类型 枚举值： NORMAL_RECORD 全量录像 MOTION_RECORD 动检录像 start_time 是 String 开始时间：格式如：yyyy-MM-dd HH:mm:ss，北京时间 end_time 是 String 结束时间：格式如：yyyy-MM-dd HH:mm:ss，北京时间 expire_time 否 String 自定义Url过期时间：时间范围[30, 86400]，不填写时默认值为 30（单位/秒） 备注：仅对channels中的live_url有效 use_times 否 String 自定义Url使用次数：枚举类型，不填写时默认值为 0，RTSP协议固定为 0 备注：仅对channels中的live_url有效 枚举值： 0 使用一次 1 有效时间内任意使用，此参数对RTSP协议无效

请求示例 查询云端的录像回放地址 GET /v1/2562572829***/devices/952352LWXT***/channels/0/cloud-records/playback-url?start_time=2020-07-15 14:32:00&end_time=2020-07-15 15:32:00&playback_protocol=HOLO GET /v1/2562572829***/devices/952352LWXT***/channels/0/cloud-records/playback-url?start_time=2020-07-15 14:32:00&end_time=2020-07-15 15:32:00&playback_protocol=HLS GET /v1/2562572829***/devices/952352LWXT***/channels/0/cloud-records/playback-url?start_time=2020-07-15 14:32:00&end_time=2020-07-15 15:32:00&playback_protocol=HLS_HTTPS

响应示例 状态码： 200 OK { "device_id" : "952352LWXT***", "channel_id" : "0", "playback_url" : "holo://123.123.*.*:***/vod/952352LWXT***?token=..." } { "device_id" : "952352LWXT***", "channel_id" : "0", "playback_url" : "http://123.123.*.*:***/vod/vod.m3u8?token=...&device_id=952352LWXT***&channel_id=0" } { "device_id" : "952352LWXT***", "channel_id" : "0", "playback_url" : "https://123.123.*.*:***/vod/vod.m3u8?token=...&device_id=952352LWXT***&channel_id=0" }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 录像列表总数 device_id String 设备ID：设备唯一标识，长度范围[1,32] channel_id String 通道ID：长度范围[1,20] records Array of Record objects 录像列表信息 表5 Record 参数 参数类型 描述 record_id String 录像ID：长度范围[1,32] record_name String 录像名称：长度范围[1,32] record_type String 录像类型：枚举类型 枚举值： NORMAL_RECORD 全量录像 MOTION_RECORD 动检录像 record_size Integer 录像文件大小：单位（字节） alarm_rec_type String 告警录像类型：枚举类型，非告警录像值为空（null） start_time String 录像开始时间：格式如：yyyy-MM-dd HH:mm:ss，2020-06-12 17:31:00 end_time String 录像结束时间：格式如：yyyy-MM-dd HH:mm:ss，2020-06-12 17:31:00

响应示例 状态码： 200 OK { "total" : 1, "device_id" : "952352LWXT***", "channel_id" : "0", "records" : [ { "record_id" : "1000000", "start_time" : "2020-06-12 17:31:00", "end_time" : "2020-06-13 12:50:00", "record_name" : "录像1", "record_size" : 1024, "record_type" : "NORMAL_RECORD" } ] }

URI GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/cloud-records 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度固定为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 channel_id 是 String 通道ID： 好望设备：取值范围[0,999] 国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取 表2 Query参数 参数 是否必选 参数类型 描述 start_time 是 String 开始时间：格式如：yyyy-MM-dd HH:mm:ss，北京时间 end_time 是 String 结束时间：格式如：yyyy-MM-dd HH:mm:ss，北京时间 limit 否 Integer 单页数量：取值范围[1,1000]，不填写时默认值为 10 offset 否 Integer 偏移量：offset为0时表示查询第一页的数据，取值范围[0,1000000]，不填写时默认为 0 record_type 否 String 录像类型：枚举类型，不填则默认包含以下两种录像类型 枚举值： NORMAL_RECORD 全量录像 MOTION_RECORD 动检录像

请求示例 查询通道实况播放地址 POST /v1/123456789*****/media/urls/batch-delete { "urls":[ { "url":"jvmp://123.123.123.123:7070/live/210123456SMY***?token=content***" }, { "url":"https://123.123.123.123:20378/live/210123456SMY***.flv?token=content***" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 urls 是 Array of BatchDeleteUrls objects 要删除的url列表：播放地址列表 表4 BatchDeleteUrls 参数 是否必选 参数类型 描述 url 是 String 要删除的url：从其他接口获取的播放地址 备注：不支持RTSP协议

响应示例 状态码： 200 OK { "playback_connections": { "device_id": "219123456CYP***", "channel_id": "0", "cloud_trans_connections": { "playback_url": "jvmp://123.123.123.123:7070/vod/219123456CYP***?token=content***" }, "p2p_connections": { "token": "content***", "device_state": "ONLINE", "p2p_nodes": [ { "node_type": "COMMON", "address_type": "IPV4", "address": [ "123.123.123.123" ], "tcp_port": 0, "udp_port": 7050 } ], "result": { "code": "IVM.0", "msg": "Success" }, "start_time": "2023-03-20 10:05:00", "end_time": "2023-03-20 12:50:00" } } } { "playback_connections": { "device_id": "219123456CYP***", "channel_id": "0", "cloud_trans_connections": { "playback_url": "http://123.123.123.123:7083/dev_vod/vod.m3u8?token=content***&device_id=219123456CYP***&channel_id=0&stream_type=0" }, "p2p_connections": {} } } { "playback_connections": { "device_id": "219123456CYP***", "channel_id": "0", "cloud_trans_connections": { "playback_url": "https://123.123.123.123:7081/vod/vod.m3u8?token=content***&device_id=219123456CYP***&channel_id=0" }, "p2p_connections": {} } }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 playback_connections PlaybackConnectionsResp object 回放信息 表5 PlaybackConnectionsResp 参数 参数类型 描述 device_id String 设备ID：设备唯一标识，长度范围[1,32] channel_id String 通道ID：长度范围[1,20] cloud_trans_connections CloudTransChannelsResp object 转发实况连接结构体 p2p_connections P2PChannelsResp object P2P实况连接结构体：仅支持HOLO媒体播放协议，前端回放类型且请求设备为好望设备 表6 CloudTransChannelsResp 参数 参数类型 描述 playback_url String 转发回放地址：将此url输入播放地址栏开始播放 表7 P2PChannelsResp 参数 参数类型 描述 token String P2P请求Token device_state String 在线状态：枚举类型 枚举值： OFFLINE 离线 ONLINE 在线 p2p_nodes Array of P2PMTSListResp objects P2P连接可用节点 result Result object 错误信息 表8 P2PMTSListResp 参数 参数类型 描述 node_type String 节点类型：枚举类型 枚举值： COMMON 普通：普通的三线（移动，联通，电线）服务器，与地域有关，服务器由运营商托管，网络通信质量低 BETTER 优质：全网通服务器（华为云服务器等），网络通信质量高 address_type String 地址类型：枚举类型 DOMAIN 域地址 IPV4 IPv4地址 IPV6 IPv6地址 address Array of strings 媒体转发服务地址： 协议头在SDK封装 ，根据address_type决定地址类型 DOMAIN: www.huawei.com IPV4: 123.123.123.123 IPV6: fe80::f816:3eff:feed:5821 tcp_port Integer TCP端口：默认值为 0 备注：未使用0端口，tcp_port只作为兼容字段保留 udp_port Integer UDP端口：默认值为 7050 表9 Result 参数 参数类型 描述 code String 错误编码：请参见错误码 msg String 错误信息

请求示例 查询前端的录像回放地址 GET /v2/123456789*****/devices/219123456CYP***/channels/0/media/playback-connections?start_time=2023-03-20 10:05:00&end_time=2023-03-20 12:50:00&playback_protocol=HOLO&record_position=DEVICE GET /v2/123456789*****/devices/219123456CYP***/channels/0/media/playback-connections?start_time=2023-03-20 10:05:00&end_time=2023-03-20 12:50:00&playback_protocol=HTTP_HLS&record_position=DEVICE GET /v2/123456789*****/devices/219123456CYP***/channels/0/media/playback-connections?record_position=CLOUD&start_time=2023-03-20 10:05:00&end_time=2023-03-20 12:50:00&playback_protocol=HTTPS_HLS

URI GET /v2/{user_id}/devices/{device_id}/channels/{channel_id}/media/playback-connections 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度固定为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 channel_id 是 String 通道ID： 好望设备：取值范围[0,999] 国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取 表2 Query参数 参数 是否必选 参数类型 描述 playback_protocol 是 String 媒体播放协议：枚举类型，选择获取地址的媒体播放协议类型 枚举值： HOLO 好望协议的录像 HTTP_HLS 基于HTTP的HLS流媒体传输协议的录像（该协议存在安全风险，建议优先使用其他协议） HTTPS_HLS 基于HTTPS的HLS流媒体传输协议的录像 RTSP RTSP流媒体传输协议的录像（该协议存在安全风险，建议优先使用其他协议） start_time 是 String 开始时间：格式如：yyyy-MM-dd HH:mm:ss，北京时间 end_time 是 String 结束时间：格式如：yyyy-MM-dd HH:mm:ss，北京时间 record_position 是 String 录像位置，枚举类型 枚举值： CLOUD 云端录像 DEVICE 前端录像 record_type 否 String 录像类型：枚举类型，仅针对查询云端录像，不填则默认默认值为 ALL_RECORD 枚举值： ALL_RECORD 所有录像 NORMAL_RECORD 全量录像 MOTION_RECORD 动检录像 expire_time 否 String 自定义Url过期时间：时间范围[30, 86400]，不填写时默认值为 30（单位/秒） 说明： 仅对CloudTransChannelsResp中的playback_url有效 use_times 否 String 自定义Url使用次数：枚举类型，不填写时默认值为 0，RTSP协议固定为 0 枚举值： 0 使用一次 1 有效时间内任意使用，此参数对RTSP协议无效 说明： 仅对CloudTransChannelsResp中的playback_url有效 stream_type 否 String 码流类型：枚举类型，不填写时默认值为 PRIMARY_STREAM 枚举值： PRIMARY_STREAM 主码流 SECONDARY_STREAM_1 子码流1 SECONDARY_STREAM_2 子码流2

响应示例 状态码： 200 查询设备录像列表响应 { "total": 6, "device_id": "219123456CYP***", "channel_id": "0", "records": [ { "record_id": "12346556", "record_name": "_0_0_.rf", "record_type": "NORMAL_RECORD", "storage_state": 0, "record_size": 340017, "start_time": "2023-03-20 09:30:00", "end_time": "2023-03-20 09:44:39", "alarm_rec_type": [] }, { "record_id": "12346557", "record_name": "_0_1_.rf", "record_type": "NORMAL_RECORD", "storage_state": 0, "record_size": 340017, "start_time": "2023-03-20 09:46:41", "end_time": "2023-03-20 10:56:50", "alarm_rec_type": [] } ] }

请求示例 查询前端的录像列表 GET /v2/123456789*****/devices/219123456CYP***/channels/0/media/records?start_time=2023-03-20 09:30:00&end_time=2023-03-20 19:30:00&limit=2&record_type=NORMAL_RECORD&record_position=CLOUD

URI GET /v2/{user_id}/devices/{device_id}/channels/{channel_id}/media/records 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度固定为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 channel_id 是 String 通道ID： 好望设备：取值范围[0,999] 国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取 表2 Query参数 参数 是否必选 参数类型 描述 start_time 是 String 开始时间：格式如：yyyy-MM-dd HHmmss end_time 是 String 结束时间：格式如：yyyy-MM-dd HHmmss record_position 是 String 录像位置，枚举类型 枚举值： CLOUD 云端录像 DEVICE 前端录像 record_type 否 String 录像类型：枚举类型，仅针对查询云端录像，不填则默认值为 ALL_RECORD 枚举值： ALL_RECORD 所有录像 NORMAL_RECORD 全量录像 MOTION_RECORD 动检录像 limit 否 String 单页数量：取值范围[1,1000]，不填写时默认值为 10 offset 否 String 偏移量：offset为0时表示查询第一页的数据，取值范围[0,1000000]，不填写时默认值为 0 alarm_rec_type 否 String 告警录像种类（非告警录像值为null）

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 录像文件总数量 device_id String 设备ID：设备唯一标识，长度范围[1,32] channel_id String 通道ID：长度范围[1,20] records Array of ListDeviceRecordFilesResp objects 录像列表 表5 ListDeviceRecordFilesResp 参数 参数类型 描述 record_id String 录像ID：长度范围[1,32]，仅云端回放列表返回 record_name String 录像文件名称：长度范围[1,32] record_type String 录像类型：枚举类型 枚举值： NORMAL_RECORD 全量： 录像计划产生的录像 MOTION_RECORD 动检： 移动侦测产生的录像 AL RAM _RECORD 告警： 智能分析，目标分析等告警输入产生的录像 storage_state Integer 该接口返回参数新增storage_state（存储状态）枚举类型 枚举值 0 热备 标准存储 1 归档 2 回热中 归档（恢复中） 3 冷备 标准存储 record_size Integer 录像文件大小：单位（字节），仅云端回放列表返回 start_time String 录像开始时间：格式：yyyy-MM-dd HH:mm:ss end_time String 录像结束时间：格式：yyyy-MM-dd HH:mm:ss alarm_rec_type Array of string 告警录像类型：枚举类型，非告警录像值为空（null）

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken，从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 direction 是 String 方向：枚举类型 枚举值： LEFT 左转 UP 上转 RIGHT 右转 DOWN 下转 UPPER_LEFT 左上转动（设备10.0以上版本支持） UPPER_RIGHT 右上转动（设备10.0以上版本支持） LOWER_LEFT 左下转动（设备10.0以上版本支持） LOWER_RIGHT 右下转动（设备10.0以上版本支持） STOP 停止八向转动及变焦，其中停止变焦不支持直连摄像机（除E系列） IN 变焦放大 OUT 变焦缩小 ZOOM_STOP 变焦停止，所有云台设备都支持 FOCUS_FAR 聚焦变远 FOCUS_NEAR 聚焦变近 AUTO_FOCUS 自动聚焦（设备10.0以上版本支持） IRIS_OPEN 光圈变大 IRIS_CLOSE 光圈变小 FI_STOP 光圈和聚焦停止 control_lock 是 String 设备操作token不能为空（从获取云台控制权接口获取），token获取后只要进行云台控制操作就能够进行续签，不需要一直获取云台控制权 speed 否 Integer 速度，取值范围[1,10]，非必填，默认是10 mode 否 String 点动模式：默认方式，注：好望摄像机以华为协议接入的时候，变焦和聚焦时，需手动单击停止，否则会一直放大或者缩小。以onvif协议接入时，变焦和聚焦后则会自动停止 转动模式：枚举类型，非必填，国标设备只能使用转动模式，直连摄像机（除E系列）聚焦和变焦功能只能使用转动模式 枚举值： POINT 点动模式 NON_POINT 转动模式 heartbeat_mode 否 String 心跳模式：枚举类型，默认为关，只有E系列摄像机有用，心跳模式能够帮助E系列摄像机一直维持转动 枚举值： OPEN 开启心跳模式 CLOSE 关闭心跳模式

URI POST /v1/{user_id}/devices/{device_id}/channels/{channel_id}/ptz/angle-spin 表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章节

功能介绍 云台控制，支持好望、国标设备云台八向转动、点动，变焦，光圈，聚焦等能力 点动模式：只要调用一次云台移动相关命令（即direction填了除了STOP、FI_STOP、ZOOM_STOP和AUTO_FOCUS以外的参数），不需要调用STOP命令后会自动停止 转动模式：调用云台移动相关命令后（即direction填了除了STOP、FI_STOP、ZOOM_STOP和AUTO_FOCUS以外的参数），设备会一直不停转动，一直到发送STOP命令后才会停止 因华为SDC本身限制，云台控制指令短时间内无法接收过多，否则导致崩溃或连续转动，连续命令触发间隔应≥300ms

URI POST /v1/{user_id}/devices/{device_id}/channels/{channel_id}/control-lock 表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章节

响应示例 状态码： 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" }

请求参数 表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 分辨率

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章节

响应示例 状态码： 200 通道列表 { "total" : "2", "channels" : [ { "device_id" : "952352DJNR***", "device_name": "TESTNVR", "channel_id" : "0", "channel_name" : "龙岗通道1", "channel_state" : "ONLINE", "create_time" : "2020-06-26 20:42:16.0", "update_time" : "2020-06-26 20:42:16.0", "model" : "L", "access_protocol" : "HOLO", "channel_system_state" : "NORMAL", "channel_resource_state" : [ "MANAGEMENT_GRANT", "EVENT_RECORD_CLOSED", "FULL_RECORD_CLOSED" ], "channel_ability": [ "ptz" ], "channel_firmware": null, "config_state": null, "device_org_name": "组织名称123123123123", "channel_type": "IPC", "resolution": null }, { "device_id" : "952352DJNR***", "device_name": "TESTNVR", "channel_id" : "1", "channel_name" : "龙岗通道2", "channel_state" : "ONLINE", "create_time" : "2020-06-26 20:42:16.0", "update_time" : "2020-06-26 20:42:16.0", "model" : "L", "access_protocol" : "HOLO", "channel_system_state" : "NORMAL", "channel_resource_state" : [ "MANAGEMENT_GRANT", "EVENT_RECORD_CLOSED", "FULL_RECORD_CLOSED" ], "channel_ability": [ "ptz" ], "channel_firmware": null, "config_state": null, "device_org_name": "组织名称123123123123", "channel_type": "IPC", "resolution": null } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数 channels Channel object 通道列表 表5 Channel 参数 参数类型 描述 device_id String 设备ID，设备唯一标识 device_name String 设备名称 channel_id String 通道ID channel_name String 通道名称 channel_state String 通道状态 枚举值： OFFLINE 离线 ONLINE 在线 UNALLOCATED 未注册 model String 通道的设备型号 access_protocol String 接入协议 枚举值： HOLO 好望协议 GB28181 国标协议 create_time String 通道创建时间 update_time String 通道更新时间 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 行业数据流套餐关闭 CUSTOMER_GROUP_GRANT 客流客群服务开通 CUSTOMER_GROUP_ARREAR 客流客群服务欠费 CUSTOMER_GROUP_CLOSED 客流客群服务未开通 channel_ability Array of strings 通道能力集：枚举类型，参考附录设备能力集，多个能力集用逗号分隔 channel_firmware String 通道的设备固件版本号，如：SDC 10.0.0 config_state String 批量远程配置状态，枚举类型 枚举值： TRUE 可配置 FALSE 不可配置 device_org_name String 设备组织名称 channel_type String 通道类型 枚举值： IPC 通用相机 IPC-BULLET 枪机 IPC-BOX 筒机 IPC-CONCH 半球/海螺 IPDOME 球机 resolution String 分辨率

URI GET /v1/{user_id}/channels 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节 表2 Query参数 参数 是否必选 参数类型 描述 access_protocol 否 String 接入协议：枚举类型，多个查询使用逗号分隔 枚举值： HOLO 好望协议 GB28181 国标协议 channel_name 否 String 通道名称：支持英文、中文（一个汉字算两个字符）、数字、特殊字符（_-空格），长度范围[1,128] channel_resource_state 否 String 通道资源状态：枚举类型，多个查询使用逗号分隔 枚举值： 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 行业数据流套餐关闭 CUSTOMER_GROUP_GRANT 客流客群服务开通 CUSTOMER_GROUP_ARREAR 客流客群服务欠费 CUSTOMER_GROUP_CLOSED 客流客群服务未开通 channel_state 否 String 通道状态：枚举类型，仅支持单个通道状态查询 枚举值： OFFLINE 离线 ONLINE 在线 UNALLOCATED 未注册 channel_system_state 否 String 系统状态：枚举类型，仅支持单个系统状态查询 枚举值： NORMAL 正常 UNAVAILABLE_FROZEN 冻结 device_id 否 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 direction 否 String 排序方向：枚举类型，默认升序，不区分大小写 枚举值： ASC 升序 DESC 降序 limit 否 Integer 限制条数：取值范围[1,1000]，不填写时默认值为10 offset 否 Integer 偏移量：0表示从第1个匹配的数据开始查询，取值范围[0,2147483646]，不填写时默认为0 sort_by 否 String 排序字段：枚举类型，默认按创建时间create_time排序 枚举值： create_time 创建时间 update_time 更新时间

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 devices 是 Array of strings 要移动设备ID集合：数组长度范围[1,100] 单个设备： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型