华为云用户手册

URI PUT /v1/{user_id}/devices/{device_id}/channels/{channel_id} 表1 路径参数 参数 是否必选 参数类型 描述 channel_id 是 String 通道ID： 好望设备：取值范围[0,999] device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 、 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节

请求示例 用户【123456781234567812345***】设备开通【MANAGE】类型按需 /v1/123456781234567812345***/devices/channels/resources { "resource_id" : "d84c8cbabb8145b390bced5f2a774af6", "storage_day" : 7, "channels" : [ { "device_id" : "1abcdef8", "channel_id" : "1" }, { "device_id" : "12345678901234******", "channel_id" : "2" } ] }

响应示例 状态码： 200 OK { "failed_num" : 0, "channels" : [ { "device_id" : "34020000001*********", "channel_id" : "34020000001*********", "result" : { "code" : "IVM.0", "msg" : "Success" } } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 resource_id 是 String 资源ID：该资源ID可从查询包周期和按需资源列表接口进行获取 storage_day 否 Float 存储天数：例如连续收录中录像的存储天数等 当resourceID为连续收录按需服务、行业数据流按需服务、动检云存储按需服务三种按需资源时必传，参数范围为[1,365]， 不传报错 当resourceID为包周期资源时不传，默认值为0， 传非0值报错 channels 是 Array of Channel objects 通道信息 表4 Channel 参数 是否必选 参数类型 描述 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 channel_id 是 String 通道ID： 好望设备：取值范围[0,999] 国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 failed_num Integer 开通失败设备数 channels Array of Device objects 通道列表 表6 Device 参数 参数类型 描述 device_id String 设备ID channel_id String 通道ID result Result object 错误或成功信息 表7 Result 参数 参数类型 描述 code String 错误码 msg String 错误码描述信息

智能数据（TLV）相关字段枚举值说明参考 表1 trecord_type 告警类型 告警类型枚举值 释义 告警类型枚举值 释义 告警类型枚举值 释义 告警类型枚举值 释义 0 移动侦测 16 中硬遗留检测 32 偏色诊断 48 逆行 1 遮挡检测 17 音频有无告警 33 停车侦测 49 异常车牌 2 目标检测 18 音频陡降告警 34 机非人 50 交通拥堵 3 3559目标检测 19 音频陡降告警 35 过线计数 51 倒车 4 3559目标识别 20 区域进入 36 微卡口 52 车辆黑名单设防 5 入侵检测 21 区域离开 37 ITS违章信息 53 车辆白名单设防 6 目标计数 22 快速移动 38 ITS存储图片 54 遮挡车牌 7 干扰检测 23 场景变更 39 人群密度 55 打架 8 干扰检测 24 自动跟踪 40 排队检测 56 攀爬 9 网络端口状态 25 虚焦检测 41 违停球 57 跌倒 10 中硬拌线检测 26 聚集侦测 42 交通拥堵告警 58 跑步 11 中硬入侵检测 27 抖动诊断 43 机非人_目标 59 火点告警 12 中硬徘徊检测 28 画面冻结诊断 44 违法停车 60 温控告警 13 中硬遗留检测 29 雪花噪声诊断 45 非占机 - - 14 中硬移走检测 30 条纹噪声诊断 46 机占非 - - 15 中硬干扰检测 31 亮度诊断 47 压线 - - 表2 rule_type 规则线类型 规则线类型枚举值 枚举值原型 释义 规则线类型枚举值 枚举值原型 释义 0 TRIPWIRE_RULE 拌线 13 MSL_AUTO_CALIB_RULE 枪球联动自动标定 1 WANDER_RULE 漂移 14 MSL_AUTO_CALIB_RULE_CLEAR 枪球联动自动标定清除 2 ABANDON_RULE 遗留 15 FIGHTING_RULE 打架 3 REMOVE_RULE 移走 16 CLIMBING_RULE 攀爬 4 INVASION_RULE 入侵 17 FALL_DOWN_RULE 跌倒 5 ENTER_RULE 进入 18 RUNNING_RULE 跑步 6 EXIT_RULE 退出 19 FIRE_DETECT_RULE 火点检测 7 FASTMOVE_RULE 快速移动 20 CALIB_RULE_RULE 定点 8 CARDETECTION_RULE 车辆检测 21 COMM_TLV_TEXT_RULE 通用TLV字体显示 9 HUMANCOUNT_RULE 人群计数 22 MOTORBIKE_DET_RULE 电瓶车告警 10 CROWDDENSITY_DETECT_RULE 人群密度 23 LEAVEDETECT_RULE 离岗检测 11 QUEUE_DETECT_RULE 排队检测 - - - 12 IBALL_DETECT_RULE 违停球检测 - - - 表3 plate_color 车牌颜色 车牌颜色枚举值 释义 车牌颜色枚举值 释义 1 蓝底白字 9 白底红字 2 黄底黑字 10 蓝底白字 3 白底黑字 11 白底蓝字 4 黑底白字 12 白底黄字 5 绿底白字或者绿底黑字 13 白底绿字 6 渐变绿底黑字 14 白底灰字 7 黄绿双拼底黑字 15 灰底黑字 8 红底白字 - - 表4 vehicle_type 机非人类型 机非人类型枚举值 释义 机非人类型枚举值 释义 1 轿车 22 中型SUV 2 货车 23 中大型SUV 3 面包车 24 大型SUV 4 客车 25 微型面包车 5 小货车 26 MPV 6 SUV 27 轿跑 7 中型客车 28 微卡 8 摩托车-非机动车 29 皮卡 9 行人 30 中卡 10 校车 31 轻卡 11 泥头车-渣土车 32 重卡 12 高危车 33 出租车 13 骑行人 34 油罐车 14 微型轿车 35 吊车 15 小型轿车 36 海外摩托车 16 紧凑型轿车 37 公交车 17 两厢轿车 38 自行车 18 三厢轿车 39 三轮车 19 轻客 40 电瓶车 20 小型SUV 512 全部 21 紧凑型SUV - - 表5 vehicle_color 车辆颜色 车辆颜色枚举值 释义 车辆颜色枚举值 释义 1 白色 8 棕色 2 灰色（银色） 9 黑色 3 黄色 10 紫色 4 粉色 11 桔色 5 红色 12 青色 6 绿色 13 金色 7 蓝色 14 银色 表6 car_pre_brand/car_pre_brand_index 车款类型 车款枚举值 释义 车款枚举值 释义 车款枚举值 释义 车款枚举值 释义 1 GMC 2 Jeep 3 MG 4 MINI 5 smart 6 一汽 7 三菱(东南) 8 三菱 9 上汽大通 10 东南 11 东风 12 东风小康 13 东风风度 14 东风风神 15 东风风神 16 中兴 17 中华 18 中顺 19 丰田 20 五十铃 21 五菱汽车 22 众泰 23 依维柯 24 保时捷 25 克莱斯勒 26 兰博基尼 27 凯迪拉克 28 别克 29 力帆 30 北京汽车 31 北汽制造 32 北汽威旺 33 华普 34 华泰 35 华泰（现代） 36 双环 37 双龙 38 吉利 39 启晨 40 哈飞 41 大众 42 大发 43 奇瑞 44 开瑞 45 奔驰 46 奥迪 47 威麟 48 宝马 49 宝骏 50 中通 51 北方 52 华西 53 友谊 54 四川现代 55 宇通 56 安凯 57 少林 58 扬子江 59 江淮 60 梅洛 61 福田 62 穗通 63 金旅 64 金龙 65 长安 66 青年 67 黄海 68 宾利 69 广汽传祺 70 广汽吉奥 71 悍马 72 捷豹 73 斯巴鲁 74 斯柯达 75 日产 76 昌河 77 本田 78 林肯 79 标志 80 欧宝 81 比亚迪 82 永源 83 汇众 84 江铃 85 沃尔沃 86 法拉利 87 海马 88 斯特拉 89 猎豹汽车 90 玛莎拉蒂 91 现代 92 现代或黄海 93 理念 94 瑞麒 95 福特 96 福迪 97 纳智捷 98 英菲尼迪 99 荣威 100 莲花 101 菲亚特 102 讴歌 103 三一重工 104 东风或者南郡或者大运 105 东风柳汽 106 中国重汽 107 五征或者飞碟 108 凯马 109 北京 110 北京威龙 111 北奔 112 北奔重卡 113 北汽 114 华棱 115 南郡或者东风 116 唐骏 117 大运 118 广汽田野 119 精工重卡 120 红岩 121 解放 122 跃进 123 金杯 124 陕汽 125 霸龙重卡 126 飞碟 127 起亚 128 路虎 129 道奇 130 铃木 131 长城 132 长安商用 133 陆风 134 雪佛兰 135 雪铁龙 136 雷克萨斯 137 雷诺 138 风驰 139 马自达 140 黄海（北京） 141 三轮车 142 五菱 143 华泰（现代） 144 吉利金球鹰 145 吉利帝豪 146 奔腾 147 广汽 148 猎豹 149 红旗 150 金杯或福田 151 重汽豪沃 152 北汽绅宝 153 广汽日野 154 黑豹 155 东风客车 156 哈弗 157 黄海客车 158 时代汽车 159 DS 160 欧曼 161 驭胜 162 成功汽车 163 北汽幻速 164 启辰 165 莲花汽车 166 东风风光 167 重汽王牌 168 联合卡车 169 衡山 170 福汽启腾 171 陕汽重卡 172 思铭 173 安源客车 174 申龙客车 175 中车时代 176 北汽新能源 177 齐鲁客车 178 南骏汽车 179 东风超车客车 180 奥驰汽车 181 庆铃 182 斯堪尼亚 183 重汽HOWO轻卡 184 九龙 185 搅拌车 186 厢式车 187 栏板车 188 其他 189 油罐车 190 大运重卡 191 上汽依维柯红岩 192 一汽通用 193 五洲龙客车 194 知豆 195 扬子江汽车 196 申沃客车 197 宝沃 198 汉腾汽车 199 潍柴英致 200 凯翼 201 SWM斯威汽车 202 野马汽车 203 华硕 204 观致 205 大运轻卡 206 一汽柳特 207 重汽豪瀚 208 重汽重汽汕德卡 209 重汽斯太尔 210 WEY 211 腾势 212 比速汽车 213 阿斯顿马丁 214 萨博 215 陕汽通家 216 康迪全球鹰 217 长安跨越 218 卡威 219 南京金龙 220 广客 221 皮卡 222 迈凯伦 223 校车 224 领克 225 缔途 226 劳斯莱斯 227 公共巴士 228 未知 229 吊车 230 阿尔法罗密欧 231 GMC - - 表7 plate_type 车牌类型 告警类型枚举值 释义 告警类型枚举值 释义 告警类型枚举值 释义 告警类型枚举值 释义 0 未知类型 17 新能源牌 120 香港车牌 153 阿根廷车牌 1 单层蓝牌 18 其他类型 130 巴西私家车牌 160 南非私家车牌 2 单层黑牌 19 教练车牌 131 巴西商用车牌 161 南非官方车牌 3 单层黄牌 20 民航车牌 132 巴西官方车牌 162 南非外交车牌 4 双层黄牌 22 应急车牌 133 巴西外交车牌 163 南非警车牌 5 白色警牌 23 非机动车双层蓝牌 134 巴西摩托车牌 164 南非军车牌 6 白色武警 24 使馆车牌 135 巴西车牌 165 南非摩托车牌 7 双层白色武警 25 挂车车牌 140 墨西哥私家车牌 166 南非车牌 8 单层军牌 26 摩托车黄牌 141 墨西哥公交车牌 170 加纳私家车牌 9 双层军牌 27 摩托车蓝牌 142 墨西哥出租车牌 171 加纳官方车牌 10 领馆车牌 100 印尼私家车牌 143 墨西哥卡车牌 172 加纳外交车牌 12 港牌 101 印尼公共交通车牌 144 墨西哥摩托车牌 173 加纳商用车牌 13 澳门牌 102 印尼使馆车牌 145 墨西哥车牌 174 加纳摩托车牌 14 农用车牌 拖拉机 103 印尼车牌 150 阿根廷私家车牌 175 加纳车牌 15 厂内牌 110 沙特私家车牌 151 阿根廷官方车牌 180 台湾车牌 16 个性化车牌 111 沙特公共交通车牌 152 阿根廷摩托车牌 - - 父主题： 附录

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 device_org_name 是 String 设备组织名称：支持数字、中文（一个汉字算两个字符）、英文、空格、-、_，长度范围[1,50] parent_org_id 是 String 父级组织ID：由数字组成，长度范围[1,25]，可以从查询子级设备组织获取，根节点无法添加子级组织

URI PUT /v1/{user_id}/devices/{device_id}/channels/{channel_id}/cruise-track 表1 路径参数 参数 是否必选 参数类型 描述 channel_id 是 String 通道ID校验，目前只支持好望设备，取值范围[-1,999] device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 cruises_id 是 Integer 巡航轨迹ID：取值范围[1,+∞)，可以从获取巡航轨迹列表中获取 cruise_type 是 String 巡航轨迹类型：枚举类型 枚举值： CRUISE_TRACK 巡航轨迹 MODEL_TRACK 模式轨迹 PAN_TRACK 水平轨迹 TILT_TRACK 垂直轨迹 说明： 目前设备只有CRUISE_TRACK模式——基于预置点的巡航，当选择其他模式时，设备还是按照CRUISE_TRACK模式在实现，因此为避免混淆，建议传参为CRUISE_TRACK。 cruise_name 是 String 巡航轨迹名称：数字、中文、英文、空格、-、_，.，长度范围[1,128] cruise_points 是 Array of CruisePoint objects 预置位列表 表4 CruisePoint 参数 是否必选 参数类型 描述 preset_index 是 Integer 预置位序号：取值范围[1,512] dwell_time 是 Integer 预置位停留时间：取值范围[30,3600] speedLevel 是 Integer 移动速度：取值范围[0,10]，0最慢，10最快

请求示例 修改摄像机巡航轨迹 PUT /v1/2562572829***/devices/952352LWXT***/channels/1/cruise-track { "cruises_id":1, "cruise_type":"CRUISE_TRACK", "cruise_name":"巡航轨迹名称", "cruise_points":[{ "preset_index":1, "dwell_time"：30， "speed_level"：2 }] }

功能介绍 微卡口业务：在机动车进入智能感知范围时，抓取机动车相关信息进行上报的智能场景。 微卡口业务消息体的message_type值为micro_checkpoint_data。 目前行业视频管理服务会处理以下场景： itgt_type/target_type枚举值： 51 微卡口（摄像机SDC/NVR800开启微卡口/车辆智能下的功能，机动车进去区域且触发违法停车、非机动车占用机动车道、机动车占用非机动车道、逆行/倒车、压线等事件，则会被抓拍且分析出目标行为和特征信息，如：品牌、款式、主/副驾驶的情况，包括有无打电话、有无系安全带、有无遮阳板等） 52 微卡口车流量统计（摄像机SDC/NVR800开启微卡口/车辆智能下的交通流量统计功能，机动车进入区域则会被统计分析，最后得到统计分析结果，如：车辆计数、车辆平均速度、车流密度等） 表1 message_type为micro_checkpoint_data，data结构体如下： 字段名 类型 说明 device_id String 设备ID，正常情况下不为空，必传 channel_id String 通道ID，正常情况下不为空，必传 data_id String 数据ID：正常情况下不为空，必传。可用于查询智能图片数据，参考链接：智能图片下载 report_time String 上报时间：示例：2021-03-15T16:43:00+08:00 data Data object 业务信息 表2 Data 字段名 类型 说明 common Common object 通用数据定义 targets Array of Target object 目标数据定义 表3 Common 字段名 类型 说明 channel_id Int64 通道ID channel_id_ex Int64 相机扩展通道ID pts Int64 时间戳 sdc_device_id String 主从机设备ID sdc_uuid String 摄像机视频源通道号 intelligence_type Int 智能类型 image_height Int 图片高度 image_width Int 图片宽度 meta_type_mask Int 元数据类型掩码 枚举值： 1 框数据 2 图数据 8 保活数据 16 告警数据 intelligent_target_index Int 智能目标/业务类型索引 target_time_domain_info Int 配合索引使用，标识三层数据时域信息 枚举值： 0 实时框数据（检测框，规则框数据，用于复合流请流） 1 目标等其他数据（目标抓拍，定时上报，用于后端储存检索） sys_language_type Int 后台系统语言类型 target_type Int target类型，对应微卡口车流量统计类型 表4 Target 字段名 类型 说明 car_pre_brand String 品牌字符：中文字符，例如大众 car_pre_brand_index Int 品牌字符索引，当检测到机动车属性时传该值，见附录车款类型 car_sub_brand String 子款字符：中文字符，例如明锐 car_sub_brand_index Int 子款字符索引 car_year_brand String 年款字符：例如2011 cur_snap_index Int 当前抓拍序列号 device_id String 设备ID dir_id String 方向编号 data_id String 数据ID：正常情况下不为空，必传。可用于查询智能图片数据，参考链接：智能图片下载 feature_frame_flag Int 当前帧是否为关键帧，抠特征图来源帧 global_object_id Int64 智能目标全局ID ir_info String 方向信息 lane_id Int 车道号 mfr_car_pendant Int 挂件 枚举值： -1 未知 0 无 1 有 mfr_main_belt Int 主驾驶安全带 枚举值： -1 未知 0 无 1 有 mfr_main_call Int 主驾驶打电话 枚举值： -1 未知 0 无 1 有 mfr_main_sun_visor Int 主驾驶遮阳板 枚举值： -1 未知 0 无 1 有 mfr_nap_kin_box Int 纸巾盒 枚举值： -1 未知 0 无 1 有 mfr_vice_belt Int 副驾驶安全带 枚举值： -1 未知 0 无 1 有 mfr_vice_exist Int 是否有副驾驶 枚举值： -1 未知 0 无 1 有 mfr_vice_sun_visor Int 副驾驶遮阳板 枚举值： -1 未知 0 无 1 有 mfr_year_log Int 年检标 枚举值： -1 未知 0 无 1 有 panorama_pic String 全景图，已转化为url panorama_pic_size Int 全景图大小 pic_snapshot_dst_offset Int64 夏令时偏移时间：单位秒/s pic_snapshot_time Int 抓拍时间：单位秒/s pic_snapshot_timems Int64 抓拍时间：单位毫秒/ms pic_snapshot_tzone Int64 抓拍时区：单位毫秒/ms 东区为+ 西区为-，支持夏令时 plate_char String 车牌字符 plate_color Int 车牌颜色，当检测到机动车属性时传该值，见附录车牌颜色 plate_confidence Int 车牌置信度 plate_pic String 车牌抠图：已转化为图片url plate_pos Rect object 车牌位置万分比 plate_pos_abs Rect object 车牌位置绝对坐标 plate_pos_com Rect object 车牌位置万分比 plate_snapshot_type Int 车牌抓拍触发类型 枚举值： 0 手动触发 1 自动触发 plate_type Int 车牌类型，参考附录车牌类型 producer_name String 数据生成者名字 roid_id String 道路编号 target_type Int 智能业务类型 枚举值： 51 微卡口 52 微卡口车流量统计 trecord_type Int 告警类型，见附录告警类型 vehicle_color Int 车辆颜色，当检测到机动车属性时传该值，见附录车辆颜色 vehicle_direction Int 车辆运动方向 枚举值： 0 未知 1 向左 2 向右 3 向上 4 向下 vehicle_pic String 车辆特写图，已转化为url vehicle_pos Rect object 车辆位置 vehicle_pos_abs Rect object 车辆位置绝对坐标 vehicle_pos_com Rect object 车辆位置相对坐标万分比 vehicle_type Int 机非人类型，当检测到机非人属性时传该值，见附录机非人类型 vehicle_type_ext Int 机非人扩展类型，当检测到机非人属性时传该值，见附录机非人类型，例如机非人类型为轿车，扩展类型为两厢轿车 vlpr_alg_type Int 车牌算法类型 microport_traffic_statistics Int 微卡口车流量统计，历史版本遗留字段，为1代表该包为微卡口车流量统计 statistics_average_speed Int 平均速度 statistics_congestion_degree Int 交通状态 statistics_lane_count Int 微卡口车流量统计车道数量 statistics_lane_index Int 微卡口车流量统计当前车道 statistics_lane_space_used_ratio Int 车道空间占有率 statistics_lane_time_used_ratio Int 车道时间占有率 statistics_queue_length Int 排队长度 statistics_vehicle_car_large_count Int 大型车数量 statistics_vehicle_car_med_count Int 中型车数量 statistics_vehicle_car_small_count Int 小型车数量 statistics_vehicle_count Int 车辆计数 statistics_vehicle_density Int 车流密度 statistics_vehicle_head_interval Int 车头时间间隔 statistics_vehicle_head_space_interval Int 车头空间间隔 traffic_statistics_cycle Int 车流量统计周期 表5 Rect 字段名 类型 说明 x Int 检测框左上角坐标点x 计算方式，x1 = x *全景图像素宽度/ 10000 y Int 检测框左上角坐标点y 计算方式，y1 = y *全景图像素高度/ 10000 width Int 检测框宽度 计算方式 widht1 = widht *全景图像素宽度/ 10000 height Int 检测框长度 计算方式 height1 = height *全景图像素高度/ 10000 示例一、微卡口 { "message_id": 1676872319771064837, "message_type": "micro_checkpoint_data", "data": { "device_id": "219123456CYP***", "channel_id": "0", "data_id": "167687231972200300350000kcxdq130", "report_time": "2023-02-20T13:51:57+08:00", "data": { "common": { "channel_id": 101, "channel_id_ex": 101, "image_height": 720, "image_width": 1280, "meta_type_mask": 2, "pts": 786519119707, "sdc_uuid": "224440c1-966e-57eb-fd7b-8ca03739be7e", "sys_language_type": 0 }, "targets": [ { "car_pre_brand": "日产", "car_pre_brand_index": 75, "car_sub_brand": "轩逸", "car_sub_brand_index": 574, "car_year_brand": "2009_2012_2016_2018", "cur_snap_index": 0, "data_id": "167687231972200300350000kcxdq130", "device_id": "", "dir_id": "", "feature_frame_flag": 1, "global_object_id": 7200441985172434795, "ir_info": "", "lane_id": 3, "mfr_car_pendant": 0, "mfr_main_belt": 1, "mfr_main_call": 0, "mfr_main_sun_visor": 0, "mfr_nap_kin_box": 0, "mfr_vice_belt": 0, "mfr_vice_exist": 0, "mfr_vice_sun_visor": 0, "mfr_year_log": 0, "panorama_pic": "https://www.example.com/v1/holo/tlv_219123456CYP***_0_20230220_tlv_167687231972200300020000kcxdq130.jpg/static", "panorama_pic_size": 103310, "pic_snapshot_dst_offset": 0, "pic_snapshot_time": 1676872317, "pic_snapshot_timems": 1676872317957, "pic_snapshot_tzone": 28800000, "plate_char": "浙A306B1", "plate_color": 1, "plate_confidence": 97, "plate_pic": "https://www.example.com/v1/holo/tlv_219123456CYP***_0_20230220_tlv_167687231972200300320000kcxdq130.jpg/static", "plate_pos": { "x": 7726, "y": 5027, "width": 726, "height": 694 }, "plate_pos_abs": { "x": 989, "y": 362, "width": 93, "height": 50 }, "plate_pos_com": { "x": 7726, "y": 5027, "width": 726, "height": 694 }, "plate_snapshot_type": 1, "plate_type": 1, "producer_name": "ITGT", "roid_id": "", "target_type": 51, "trecord_type": 36, "vehicle_color": 2, "vehicle_direction": 4, "vehicle_pic": "https://www.example.com/v1/holo/tlv_219123456CYP***_0_20230220_tlv_167687231972200300010000kcxdq130.jpg/static", "vehicle_pos": { "x": 4429, "y": 1361, "width": 4000, "height": 4750 }, "vehicle_pos_abs": { "x": 567, "y": 98, "width": 512, "height": 342 }, "vehicle_pos_com": { "x": 4429, "y": 1361, "width": 4000, "height": 4750 }, "vehicle_type": 1, "vehicle_type_ext": 18, "vlpr_alg_type": 0 } ] } }, "test": false } 示例二、微卡口车流量统计 { "message_id": 1676874462279656679, "message_type": "micro_checkpoint_data", "data": { "device_id": "219123456CYP***", "channel_id": "0", "data_id": "167687446220900300350000kcxdq130", "report_time": "2023-02-20T14:27:40+08:00", "data": { "common": { "channel_id": 101, "channel_id_ex": 101, "image_height": 720, "image_width": 1280, "meta_type_mask": 2, "pts": 146494760, "sdc_uuid": "224440c1-966e-57eb-fd7b-8ca03739be7e", "sys_language_type": 0, "target_type": 52 }, "targets": [ { "car_pre_brand": "斯柯达", "car_pre_brand_index": 74, "car_sub_brand": "明锐", "car_sub_brand_index": 554, "car_year_brand": "2010", "cur_snap_index": 0, "data_id": "167687446220900300350000kcxdq130", "microport_traffic_statistics": 1, "device_id": "", "dir_id": "", "feature_frame_flag": 1, "global_object_id": 7202244372492976151, "ir_info": "", "lane_id": 3, "mfr_car_pendant": 0, "mfr_main_belt": 1, "mfr_main_call": 0, "mfr_main_sun_visor": 0, "mfr_nap_kin_box": 0, "mfr_vice_belt": 0, "mfr_vice_exist": 0, "mfr_vice_sun_visor": 0, "mfr_year_log": 0, "panorama_pic": "https://www.example.com/v1/holo/tlv_219123456CYP***_0_20230220_tlv_167687446220900300020000kcxdq130.jpg/static", "panorama_pic_size": 98965, "pic_snapshot_dst_offset": 0, "pic_snapshot_time": 1676874459, "pic_snapshot_timems": 1676874459506, "pic_snapshot_tzone": 28800000, "plate_char": "浙A068PN", "plate_color": 1, "plate_confidence": 97, "plate_pic": "https://www.example.com/v1/holo/tlv_219123456CYP***_0_20230220_tlv_167687446220900300320000kcxdq130.jpg/static", "plate_pos": { "x": 5953, "y": 3222, "width": 765, "height": 472 }, "plate_pos_abs": { "x": 762, "y": 232, "width": 98, "height": 34 }, "plate_pos_com": { "x": 5953, "y": 3222, "width": 765, "height": 472 }, "plate_snapshot_type": 1, "plate_type": 1, "producer_name": "ITGT", "statistics_average_speed": 0, "statistics_congestion_degree": 1, "statistics_lane_count": 3, "statistics_lane_index": 1, "statistics_lane_space_used_ratio": 0, "statistics_lane_time_used_ratio": 0, "statistics_queue_length": 0, "statistics_vehicle_car_large_count": 0, "statistics_vehicle_car_med_count": 0, "statistics_vehicle_car_small_count": 0, "statistics_vehicle_count": 0, "statistics_vehicle_density": 0, "statistics_vehicle_head_interval": 0, "statistics_vehicle_head_space_interval": 0, "roid_id": "", "target_type": 52, "traffic_statistics_cycle": 5, "trecord_type": 36, "vehicle_color": 2, "vehicle_direction": 4, "vehicle_pic": "https://www.example.com/v1/holo/tlv_219123456CYP***_0_20230220_tlv_167687446220900300010000kcxdq130.jpg/static", "vehicle_pos": { "x": 3648, "y": 569, "width": 3281, "height": 3625 }, "vehicle_pos_abs": { "x": 467, "y": 41, "width": 420, "height": 261 }, "vehicle_pos_com": { "x": 3648, "y": 569, "width": 3281, "height": 3625 }, "vehicle_type": 1, "vehicle_type_ext": 17, "vlpr_alg_type": 0 } ] } }, "test": false }

URI POST /v1/{user_id}/devices/{device_id}/channels/{channel_id}/preset-position/move 表1 路径参数 参数 是否必选 参数类型 描述 channel_id 是 String 通道ID校验：目前只支持好望设备，取值范围[-1,999] device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 control_token 是 String 用户设备控制token（从获取云台控制权接口获取） preset_index 是 String 预置位序号：取值范围[1,512]

响应示例 状态码： 200 OK { "device_id" : "952352DJNR***", "channel_id" : "0", "all_day" : false, "is_upload_record": true, "time_sections" : [ { "day_of_week" : 1, "start_time" : "00:02:00", "end_time" : "00:05:00" }, { "day_of_week" : 1, "start_time" : "00:06:00", "end_time" : "00:08:00" }, { "day_of_week" : 2, "start_time" : "00:02:00", "end_time" : "00:05:00" } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 device_id String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 channel_id String 通道ID： 好望设备：取值范围[0,999] 国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取 all_day Boolean 是否全程录像：枚举类型， 如果为true，time_sections省略 枚举值： true 是 false 否 is_upload_record Boolean 是否开启录像缓存补录：枚举类型。可以在web界面远程配置--企业统一配置--断网补录中更改此配置。 枚举值： true 开启 false 关闭 time_sections Array of TimeSection objects 通道录像计划时间段 表4 TimeSection 参数 参数类型 描述 day_of_week Integer 日期：取值范围[1,7]（对应周一~周日） start_time String 录像开始时间：格式为HH:mm:ss，范围为[00:00:00~23:59:59] end_time String 录像结束时间：格式为HH:mm:ss，范围为[00:00:00~23:59:59] 状态码： 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码：失败对应具体错误码，成功无 error_msg String 请求失败时为：错误信息，成功无 状态码： 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码：失败对应具体错误码，成功无 error_msg String 请求失败时为：错误信息，成功无 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码：失败对应具体错误码，成功无 error_msg String 请求失败时为：错误信息，成功无

URI GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/record-plan 表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章节

URI GET /v1/{user_id}/space-heatmap 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节 表2 Query参数 参数 是否必选 参数类型 描述 channel_id 是 String 通道ID： 好望设备：取值范围[0,999] device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 start_time 是 String 开始时间：时间格式为yyyy-MM-dd HH:mm:ss type 是 String 时间类型：枚举类型 枚举值： YEAR 年统计 MONTH 月统计 WEEK 周统计 DAY 日统计

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" }

请求示例 查询前端的录像回放地址 GET /v1/2562572829***/devices/952352LWXT***/channels/0/device-records/web-playback-url?start_time=2021-12-04 15:09:00&end_time=2021-12-04 15:10:00&playback_protocol=HLS_DEV GET /v1/2562572829***/devices/952352LWXT***/channels/0/device-records/web-playback-url?start_time=2021-12-04 15:09:00&end_time=2021-12-04 15:10:00&playback_protocol=HLS_DEV_HTTPS

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

URI GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/device-records/web-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参数 参数 是否必选 参数类型 描述 protocol 是 String 媒体播放协议：枚举类型，选择获取地址的媒体播放协议类型 枚举值： HLS_DEV 基于HTTP的HLS流媒体传输协议的前端录像 HLS_DEV_HTTPS 基于HTTP的HLS流媒体传输协议的前端录像 RTSP_DEV RTSP流媒体传输协议的前端录像 HTTP_FLV_DEV 基于HTTP的FLV媒体协议的前端录像（仅适用于国标设备） HTTPS_FLV_DEV 基于HTTPS的FLV媒体协议的前端录像（仅适用于国标设备） 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（单位/秒） 备注：仅对响应Body参数中的playback_url有效 use_times 否 String 自定义Url使用次数：枚举类型，不填写时默认值为 0，RTSP_DEV协议固定为 0 备注：仅对响应Body参数中的playback_url有效 枚举值： 0 使用一次 1 有效时间内任意使用，此参数对RTSP_DEV协议无效 trans_protocol 否 String 传输协议：枚举类型，不填写时默认值为 TCP，仅适用于gb28181，其它接入协议无效 枚举值： TCP TCP传输协议 UDP UDP传输协议 stream_type 否 String 码流类型：枚举类型，不填写时默认值为 PRIMARY_STREAM 枚举值： PRIMARY_STREAM 主码流 SECONDARY_STREAM_1 子码流1 SECONDARY_STREAM_2 子码流2

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 group_name 是 String 目标库分组名称：最大为63位 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 group_type 否 String 目标库分组类型：枚举类型，不同设备支持的枚举类型不一样 NVR800设备下的目标库分组类型：不填默认为白名单 枚举值： WHITE 白名单 STRANGE 陌生人 BLACK 黑名单 SDC设备下的目标库分组类型：不填默认为其他名单 枚举值： OTHER 其他名单 DEFAULT 默认名单 WHITE 白名单 IVS1800设备下的目标库分组类型：不填默认为白名单 枚举值： WHITE 白名单 STRANGE 陌生人 RED 红名单

URI DELETE /v1/{user_id}/device-orgs/{device_org_id} 表1 路径参数 参数 是否必选 参数类型 描述 device_org_id 是 String 设备组织ID：由数字组成，长度范围[1,25]，可以从查询子级设备组织获取，根节点不允许删除 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节

请求示例 通过版本查询设备能力集 POST /v1/2562572829***/devices/ability { "versions" : [ { "device_type" : "IPC", "model" : "C3050-10-LI-PV(3.6mm)", "firmware" : "SDC 10.0.RC11" }, { "device_type" : "IPC", "model" : "C3050-10-LI-PV(3.6mm)", "firmware" : "SDC 10.0.RC12" } ], "need_specification" : true, "ability" : [ "ptz", "soundlightalarm" ] }

响应示例 状态码： 200 OK { "abilities" : [ { "device_type" : "IPC", "firmware" : "SDC 10.0.RC11", "model" : "C3050-10-LI-PV(3.6mm)", "abilities" : { "ptz" : { "support" : false }, "soundlightalarm" : { "alarm_voice_file_max_num" : "6", "alarm_voice_one_file_max_size" : "76800", "alarm_voice_file_max_size" : "524288", "support" : false } } }, { "device_type" : "IPC", "firmware" : "SDC 10.0.RC12", "model" : "C3050-10-LI-PV(3.6mm)", "abilities" : { "ptz" : { "support" : false }, "soundlightalarm" : { "support" : false } } } ] }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 abilities Array of DeviceVersionAndAbilities objects 设备版本对应能力集返回体 表6 DeviceVersionAndAbilities 参数 参数类型 描述 device_type String 设备类型 model String 设备款型 firmware String 设备软件版本 abilities Object 设备能力集规格

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 versions 是 Array of versions objects 设备版本 need_specification 否 Boolean 是否需要返回具体规格，不传默认false ability 否 Array of strings 查询的云上能力集列表，不传默认查询所有能力集 表4 versions 参数 是否必选 参数类型 描述 device_type 是 String 设备类型，必填，可以通过用户根据设备ID查询设备信息详情获取 firmware 是 String 设备软件版本，必填，可以通过用户根据设备ID查询设备信息详情获取 model 是 String 设备固件类型（设备款型），必填，可以通过用户根据设备ID查询设备信息详情获取

URI GET /v1/{user_id}/devices/{device_id}/gateway 表1 路径参数 参数 是否必选 参数类型 描述 device_id 是 String 设备ID： 国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节