华为云用户手册

响应示例 状态码： 200 OK { "device_id" : "5648781*****", "channel_id" : "666", "resources" : [ { "resource_id" : "c0d3c9f9b70b4c3599fe4a98eb2a****", "resource_name" : "90天动检检 云存储 月套餐", "resource_type_code" : "MOTION", "resource_state" : "NORMAL" }, { "resource_id" : "c0d3c9f9b70b4c3599fe4a98eb2a****", "resource_name" : "设备按需动检收录套餐", "resource_type_code" : "MOTION", "resource_state" : "NORMAL" } ] }

URI GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/resources 表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 表3 响应Body参数 参数 参数类型 描述 device_id String 设备id channel_id String 通道id resources Array of ChannelResource objects 响应信息 表4 ChannelResource 参数 参数类型 描述 resource_id String 资源id resource_name String 资源名称 resource_type_code String 资源类型编码 MANAGE 视图接入调阅 NORMAL 连续云存储 DATAFLOW 行业数据流 MOTION 动检云存储 resource_state String 资源状态 NORMAL 正常 ARREARS 欠费 UNAVAILABLE 不可使用冻结

响应参数 状态码： 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界面获取 plans Array of GetChannelRecordAlarmPlan objects 动检录像计划列表 all_day Boolean 是否全程录像：枚举类型。 默认为false，如果为true，time_sections省略（不进行校验） 枚举值： true 是 false 否 time_sections Array of TimeSection objects 通道录像计划时间段 表4 GetChannelRecordAlarmPlan 参数 参数类型 描述 alarm_type String 告警类型：枚举类型 枚举值： motion_detection 移动侦测报警 io_event 外部IO输入报警 target_alarm 目标报警 mask_alarm 口罩报警 people_queue_alarm 排队长度报警 people_count_region_alarm 区域人数统计报警 people_count_line_alarm 过线人数统计报警 over_line_alarm 越线检测报警 region_invasion_alarm 区域入侵报警 region_in_alarm 区域进入报警 region_out_alarm 区域离开报警 fast_move_alarm 快速移动报警 linger_alarm 徘徊检测报警 thirdparty_intelligent 第三方告警 face_alarm 人脸告警 abandon_alarm 物品遗留告警 removed_alarm 物品移走告警 electric_bicycle_alarm 电瓶车检测告警 people_leave_station_alarm 人员离岗告警 lift_electric_alarm 电梯电瓶车告警_新 occlusion_alarm 遮挡告警 advance_time String 预录时间，取值范围[1,59] after_time String 延录时间，取值范围[1,59] 表5 TimeSection 参数 参数类型 描述 day_of_week Integer 日期：取值[1,7]（对应周一~周日） 最小值：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]

响应示例 状态码： 200 OK { "device_id" : "952352LWXT***", "channel_id" : "0", "plans" : [ { "alarm_type" : "motion_detection", "advance_time" : 30, "after_time" : 15 } ], "all_day" : false, "time_sections" : [ { "day_of_week" : 1, "start_time" : "00:02:00", "end_time" : "00:05:00" } ] }

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

基本消息结构体 推送消息给企业ISV平台时，各参数定义如下： 请求头header，当用户设置auth_key的值，会携带这两个请求头 字段名 类型 是否可为空 说明 X-Ivm-Timestamp Int64/long整型 不为空 UNIX时间戳，整形正数，固定长度10，1970年1月1日以来的秒数，表示回调请求发起时间。 X-Ivm-Signature String 不为空 接口请求token，token生成方式，为将callback_url，X-Ivm-Timestamp，auth_key三个字段进行拼接，字段中间以竖线（|）分割，后计算sha256值。即 X-Ivm-Signature = sha256(callback_url|X-Ivm-Timestamp|auth_key)，回调消息接收端接收请求后可自行计算该值并做比较，若不相等，则请求非法 结构体req 字段名 类型 是否可为空 说明 message_id Int64/long整型 不为空 消息ID：该消息的唯一标识，根据时间戳生成（18到32位的数字），无重复 message_type String 可能为空 消息类型：分为设备智能告警消息、设备异常告警消息、设备解绑消息和设备智能数据消息四大类 枚举值： 设备智能告警消息： device_alarm 智能告警消息，包含目标智能告警，口罩告警，周界告警，人群态势告警及第三方智能告警消息等 设备异常告警消息： device_status 设备异常消息，包含设备/通道上下线告警，通道名称修改，以及设备升级失败 设备解绑消息： device_unbind 设备解绑和套餐解绑的消息 设备智能数据消息： target_data 智能业务中的目标及目标整体业务 third_data 第三方智能业务，目前是提供整个数据包，使用方需自行解析。订阅时要和第三方智能告警数据区分开 vehicle_data 智能业务中的机非人业务 head_shoulder_data 智能业务中的头肩业务 behavior_analysis_data 智能业务中的行为分析与人车物分离 micro_checkpoint_data 智能业务中的微卡口业务 data Object 可能为空 智能告警信息： 当 message_type 不同时，data 格式不同，可参考message_type里各种类型的介绍； 当智能类型算法升级时，可能会在推送的结构体里添加新字段； test Boolean 不为空 当test字段为true时，表示这是配置回调URL时测试是否可访问的消息，被调用方需要返回响应码为200。注意，此时message_type和data字段不传。 当test字段为false时，表示这是一条推送消息，message_type和data字段正常传入。 父主题： 告警推送消息体结构

功能介绍 设备智能数据：设备安装相关算法后，在相应场景触发时，设备推送的算法结果消息。客户可根据算法结果实现自己的业务。 设备智能数据包含多种业务，每种业务的消息结构体都有差异，以下章节会对不同业务的消息结构体进行讲解。 设备智能数据消息体的message_type值为以下枚举值： target_data 智能业务中的目标及目标整体业务 third_data 第三方智能业务，目前是提供整个数据包，使用方需自行解析。订阅时需要和第三方智能告警数据区分开，一个是第三方TLV智能数据，一个是第三方智能告警 vehicle_data 智能业务中的机非人业务 head_shoulder_data 智能业务中的头肩业务 behavior_analysis_data 智能业务中的行为分析与人车物分离 micro_checkpoint_data 智能业务中的微卡口业务 备注：随着设备算法的升级可能会有出现文档中未描述的字段

响应参数 状态码： 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 错误码描述信息

请求示例 用户【12345678123456781*******】设备关闭【MANAGE】类型按需 /v1/12345678123456781*******/devices/channels/resources { "resource_type_code" : "RECORD", "channels" : [ { "device_id" : "1abc****", "channel_id" : "1" }, { "device_id" : "1234567890123*******", "channel_id" : "2" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 resource_type_code 是 String 待解绑的资源类型 MANAGE 视图接入调阅服务 RECORD 收录服务（连续云存储） DATAFLOW 行业数据流服务 MOTION 动检云存储 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 OK { "failed_num" : 0, "channels" : [ { "device_id" : "3402000000132*******", "channel_id" : "3402000000132*******", "result" : { "code" : "IVM.0", "msg" : "Success" } } ] }

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

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

URI GET /v1/{user_id}/statistics/people 表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页面上获取 end_date 否 String 结束时间：日期格式为yyyyMMdd type为DAY或者YEAR时不用填写 type为WEEK或者MONTH时不填默认取start_date值 type为CUSTOMIZE时必填 start_date 是 String 开始时间：日期格式为yyyyMMdd type为DAY时，查询start_date当天人流信息 type为WEEK时，查询start_date当周人流信息 type为MONTH时，查询start_date当月人流信息 type为YEAR时，查询start_date当年人流信息 type 是 String 报表类型：枚举类型 枚举值： DAY 日统计 WEEK 周统计，需注意的是，如果start_date和end_date的日期跨度大于等于7天，会以MONTH 模式处理和返回数据 MONTH 月统计，需注意的是，如果start_date和end_date的日期跨度小于7天，会以WEEK 模式处理和返回数据 YEAR 年统计 CUSTOMIZE 自定义统计，预留，暂不使用

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 in Array of integers 进入人数列表 type是DAY时返回是当天24小时的人流流入统计数据 type是WEEK时返回是当周7天的人流流入统计数据 type是MONTH时返回是当月天数的人流流入统计数据 type是YEAR时返回是当年12个月的人流流入统计数据 out Array of integers 离开人数列表 type是DAY时返回是当天24小时的人流流出统计数据 type是WEEK时返回是当周7天的人流流出统计数据 type是MONTH时返回是当月天数的人流流出统计数据 type是YEAR时返回是当年12个月的人流流出统计数据

URI GET /v1/{user_id}/targets/count 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK 表2 Query参数 参数 是否必选 参数类型 描述 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 group_id 是 Integer 目标库分组ID，非负值，从获取目标库分组接口获取

智能数据（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 阿根廷摩托车牌 - - 父主题： 附录

功能介绍 云台控制，支持好望、国标设备云台八向转动、点动，变焦，光圈，聚焦等能力 点动模式：只要调用一次云台移动相关命令（即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}/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章节

请求参数 表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 关闭心跳模式

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

响应参数 状态码： 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

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 动检录像

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

响应示例 状态码： 200 OK { "device_id" : "952352LWXT***", "device_username" : "admin", "sip_server_id" : "3402000000***", "sip_server_domain" : "3402***", "sip_server_host" : "123.123.*.*", "sip_server_port" : 5060 }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 device_username String sip服务器用户名 sip_server_id String SIP服务器ID sip_server_domain String SIP服务器域 sip_server_host String SIP服务器地址 sip_server_port String SIP服务器端口 device_id String 设备ID：由数字组成，长度为20个字符长度

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 group_id Integer 目标库分组ID：目标库标识符 target_ids Array of TargetResultVo objects 目标ID列表 表5 TargetResultVo 参数 参数类型 描述 target_id String 目标ID：目标标识符 result Result object 结果码 表6 Result 参数 参数类型 描述 code String 错误编码 msg String 错误信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 否 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 group_id 是 Integer 目标库分组ID：非负值，从获取目标库分组接口获取 target_ids 是 Array of strings 目标ID列表：数组长度范围[1,100] 目标ID：支持数字和-，长度范围[1,20]，需要已添加目标才可以删除，可以从按索引范围获取目标ID列表、获取目标信息、按索引范围获取目标ID信息中获取

请求示例 批量删除通道录像计划请求示例 POST /v1/2562572829***/devices/channels/record-plan { "channels" : [ { "device_id" : "952352LWXT***", "channel_id" : "0" }, { "device_id" : "952352DJNR***", "channel_id" : "0" } ] }