华为云用户手册

请求参数 表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最快

修订记录 表1 修订记录 修改时间 修改说明 2023-08-24 第六十一次正式发布 本次变更如下： 9、10 敏感数据脱敏 隐藏文档中涉及token、user_id、设备ID、AKSK、BASE64数据、图片等敏感信息 2023-08-22 第六十次正式发布 本次变更如下： 12.1批量开通设备通道服务 请求和响应示例的假数据添加***脱敏处理 12.2批量关闭设备通道服务 请求和响应示例的假数据添加***脱敏处理 2023-08-16 第五十九次正式发布 本次变更如下： 6.7批量添加设备 表4里面的algorithm行的描述列新增了md5使用的风险说明 批量变更IP地址为123.123.123.123 批量变更不对外公开地址为www.example.com 2023-07-25 第五十八次正式发布 本次变更如下： 8.5云台控制：表3里面的mode行的描述列做了点动模式的描述新增以及转动模式的描述更改 2023-07-1 第五十七次正式发布 本次变更如下： 替换 好望云服务 为行业视频管理服务。 2023-06-26 第五十六次正式发布 本次变更如下： 修正 SDK中心 链接地址。 9.3获取回放地址统一接口响应结构与字段更正 9.4批量删除播放地址接口功能介绍修改 11.5请求参数中的record_type去掉了枚举值all 19.1请求示例字段更正 2023-06-02 第五十五次正式发布 本次变更如下： 6.4章节请求参数modify_type描述修改 6.5和6.7章节请求参数device_name和device_password描述修改 6.6和6.7章节请求参数description描述修改 7.1章节功能描述修改 9.1新增获取实况地址统一接口 9.2新增查询回放列表统一接口 9.3新增获取回放地址统一接口 9.4章节接口功能描述修改 9.5-9.12章节相应接口更迭为旧接口，加上【旧】字样 9.5-9.12章节功能描述修改，各种参数描述部分修正 10.1章节部分告警描述修改补充，部分TLV字段描述修改补充 2023-02-13 第五十四次正式发布 本次变更如下： 5.1返回参数is_leaf增加返回值的描述 19巡航轨迹和预置位下的章节重新排序，并添加只支持好望设备说明 19.3响应参数preset_index描述修改 19.5添加获取云台控制权接口的链接 19.6响应示例修改 19.7响应参数cruise_type巡航轨迹类型增加枚举描述 19.8和19.10章节请求参数speedLevel描述修改 2023-02-02 第五十三次正式发布 本次变更如下： 11.1查询人流统计日周年信息关于MONTH枚举类型补充改正 11.2响应体描述补充 17.1增加仅支持好望设备/通道的提示 17.2增加仅支持好望设备/通道的提示 2023-01-13 第五十二次正式发布 本次变更如下： 8.3查询通道详情章节响应体中新增通道类型字段 2023-01-10 第五十一次正式发布 本次变更如下： DEVICE_ALARM 消息类型添加字段 alarm_attr 2023-01-04 第五十次正式发布 本次变更如下： auth_key 参数完善 告警智能图片下载兼容 THIRDPARTY_INTELLIGENT 三方告警类型 2023-01-04 第四十九次正式发布 本次变更如下： 20.5添加预置位章节增加直连场景的入参。 2023-01-03 第四十八次正式发布 本次变更如下： 批量添加目标图片功能，参数提示描述完善 2022-12-30 第四十七次正式发布 本次变更如下： 8.2 查询通道列表章节，增加返回channel_type字段。 原19.8章节后插入三个章节描述新版本目标库新增，修改，删除功能的接口。 2022-11-25 第四十六次正式发布 本次变更如下： 11.1 查询人流统计日月周年信息章节，type字段描述修改。 2022-11-25 第四十五次正式发布 本次变更如下： 修改API管理， 将调用的地址不隐藏，让文档更易懂。 2022-09-30 第四十四次正式发布 本次变更如下： 新增长尾算法接口 2022-08-08 第四十三次正式发布 本次变更如下： 配置用户 消息通知 URL 添加 HEAD_SHOULDER_DATA、BEHAVIOR_ANALYSIS_DATA、MICRO_CHECKPOINT_DATA 枚举值 2022-08-08 第四十二次正式发布 本次变更如下： 获取时间热度图统计中修改type枚举值分隔符 获取空间热度图统计中修改type枚举值分隔符 2022-07-20 第四十一次正式发布 本次变更如下： 新增设备云上能力集查询接口 设备、通道详情接口新增云上能力集查询相关字段 新增动检录像计划相关接口 2022-06-08 第四十次正式发布 本次变更如下： 查询通道的录像计划接口新增字段 2022-06-02 第三十九次正式发布 本次变更如下： 云台枚举值新增描述 2022-05-31 第三十八次正式发布 本次变更如下： HLS实况URL增加禁用音频选项 批量获取P2P回放URL接口中增加开始结束时间选项 2022-04-21 第三十七次正式发布 本次变更如下： 修改设备信息的入参返回值 云台点动接口参数补充 2022-04-19 第三十六次正式发布 本次变更如下： 修改目标库相关接口的入参返回值格式问题 2022-03-29 第三十五次正式发布 本次变更如下： 原先接口缺少的约束和字段补全 新增云台点动接口 新增设备目标授权配置接口 2022-03-25 第三十四次正式发布 本次变更如下： 添加空间热力图base64转RGB的伪代码说明 2022-03-14 第三十三次正式发布 本次变更如下： 接口api发布：新增目标库与修改目标库接口请求示例错误修正 2022-03-12 第三十二次正式发布 本次变更如下： 接口api发布：新增目标库，修改目标库，删除目标库 错误码新增：IVM.20000036 2022-03-02 第三十一次正式发布 本次变更如下： 目标库接口目标年龄用例String类型修改为Integer类型 云台转动填写新的档位，云台光圈聚焦增加一键聚焦功能和点动聚焦功能 目标库添加增加external_target_id 2022-02-23 第三十次正式发布 本次变更如下： 新增错误码：IVM.20090016 2022-02-18 第二十九次正式发布 本次变更如下： 新增支持wss协议播放接口 新增媒体播放管理部分接口支持url自定义超时时间和次数 修改云端录像record_type枚举值 2022-02-11 第二十八次正式发布 本次变更如下： 修正查询通道的前端录像回放地址(仅支持HLS协议)接口 2022-01-29 第二十七次正式发布 本次变更如下： 修改itgt_type 字段枚举值 2022-01-17 第二十六次正式发布 本次变更如下： 修改告警推送消息体结构的message_type为device_status时的请求示例 2022-01-12 第二十五次正式发布 本次变更如下： 批量获取设备实况播放地址删除仅支持国标设备描述 2021-12-27 第二十四次正式发布 本次变更如下： 周界检测告警参数配置和获取周界检测告警参数添加结构体 region 、point 2021-12-16 第二十三次正式发布 本次变更如下： 巡航轨迹和预置位功能重新上线 设备密码修改 查询设备码流能力和码流列表特性 2021-12-09 第二十二次正式发布 本次变更如下： 添加三种智能业务：头肩业务、行为分析与人车物分离、微卡口业务 target_data 目标及目标整体业务和 vehicle_data 机非人业务新增字段 2021-12-06 第二十一次正式发布 本次变更如下： 添加HLS协议实况、云端回放、前端回放地址 2021-11-25 第二十次正式发布 本次变更如下： 设备密码、码流远程配置、巡航轨迹和预置位接口删除 2021-11-24 第十九次正式发布 本次变更如下： 设备密码和码流远程配置接口添加 2021-11-23 第十八次正式发布 添加各种类型设备目标库字段支持情况 2021-11-05 第十七次正式发布 本次变更如下： 告警推送消息结构体的 target_data 类型新增五个字段： itgt_version String 目标识别算法版本号 quality_score Int 目标识别目标抠图质量分 target_url String 目标抠图的 URL target_all_pic_url String 目标整体抠图的 URL panorama_url String 目标全景的 URL 2021-11-01 第十七次正式发布 本次变更如下： 巡航轨迹和预置位接口添加 2021-08-27 第十六次正式发布 本次变更如下： 修改通道名称修改为只支持好望协议，通道名称修改特殊字符增加. 2021-08-19 第十五次正式发布 本次变更如下： OSD名称相关，名字增加对换行符的支持 2021-08-18 第十四次正式发布 本次变更如下： 添加设备升级失败的字段，及响应示例 2021-08-13 第十三次正式发布 本次变更如下： 添加查询用户URL的响应示例 2021-08-06 第十二次正式发布 本次变更如下： 修改配置周界告警参数配置的请求示例 给配置用户消息通知URL接口新增了接口说明 2021-07-23 第十一次正式发布 本次变更如下： 批量添加设备(仅支持GB28181协议)接口增加algorithm字段 添加目标库接口文档 发送云台聚焦和光圈控制命令params改为必填参数 2021-07-08 第十次正式发布 本次变更如下： 消息回调接口增加auth_key字段 2021-06-25 第九次正式发布 本次变更如下： 解决：消息推送ISV，回调URL接口，告警图片下载接口的MG信息问题 补充描述，智能及告警图片下载路径有效期五分钟 2021-06-11 第八次正式发布 本次变更如下： 告警推送新增物品遗留、移走、电瓶车等告警类型，图片下载接口新增第三方智能算法。 新增告警参数配置（两个接口） 2021-05-14 第七次正式发布 本次变更如下： 新增云端抓拍目录，新增云端抓拍设备接口 2021-04-28 第六次正式发布 本次变更如下： 部分接口增加详细说明，比如设备实况地址获取接口仅支持国标 2021-04-15 第五次正式发布 本次变更如下： 下线FLV、WASM等内容。 2021-04-12 第四次正式发布 本次变更如下： 告警推送消息体结构，修改 rect 对象的字段名 2021-04-06 第三次正式发布 本次变更如下： API参考中增加“附录”目录，附录中存放状态码、错误码以及其他北向接口调用参考信息； 告警消息结构体从“用户指南”移动到了“消息管理”目录中。 LiveWebURLDto参数对象中的“stream_type”码流参数类型补充了取值范围。 增加了“使用前必读”、“API概览”、“如何调用API”说明目录。 2021-03-05 第二次正式发布 本次变更如下： API目录名称统一去除“北向”两字。 新增“智能图片下载”、“告警图片下载”北向接口目录及所属能力接口。 2020-12-15 第一次正式发布

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 preset_name 是 String 预置位名称：数字、中文、英文、空格、-、_，.，长度范围[1,128] index 否 Integer 预置位序号：直连设备必传，非直连场景不传。取值范围[1,512]

URI POST /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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 preset_positions Array of getPresetPositionItem objects 预置位信息列表 表4 getPresetPositionItem 参数 参数类型 描述 preset_index Integer 预置点位序号 preset_name String 预置点位名称 jpg_base64 String jpg图片，jpg格式的图片经过base64编码后的字符串

URI GET /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

响应参数 状态码： 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信息中获取

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 日统计

响应示例 状态码： 200 OK { "total" : 2, "resources" : [ { "resource_id" : "156", "resource_type_code" : "MOTION", "resource_name" : "设备按需动检收录套餐", "resource_state" : "NORMAL", "total_num" : 1, "usage_num" : 0, "version" : "ENTERPRISE", "mode" : "PACKAGE ", "Exp_time" : "2023-09-22 02:22:00" }, { "resource_id" : "157", "resource_type_code" : "MOTION", "resource_name" : "90天动检检 云存储 月套餐", "resource_state" : "NORMAL", "total_num" : 1, "usage_num" : 0, "version" : "ADVANCED", "mode" : "ONDEMAND ", "Exp_time" : "2023-08-15 14:24:33" } ]}

URI GET /v1/{user_id}/resources 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 单页内显示记录数：取值范围为[1,300]，不填时默认为10 offset 否 Integer 偏移量：offset为0时表示查询第一页的数据，取值范围[0,2142147483646]，不填写时默认为0 resource_id 否 String 包周期资源ID：32位数字、字母组成 resource_type_code 否 String 资源类型 MANAGE 视图接入调阅 NORMAL 连续云储存 DATAFLOW 行业数据流 MOTION 动检云存储

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 可使用资源总数 resources Array of UserResource objects 资源列表 表5 UserResource 参数 参数类型 描述 resource_id String 资源id resource_type_code String 资源规格编码 MANAGE 视图接入调阅 NORMAL 连续云存储 DATAFLOW 行业数据流 MOTION 动检云存储 total_num Integer 资源可使用总量，套餐资源为订购的路数，按需为 -1 usage_num Integer 资源当前已使用量，设备通道每绑定一路，该使用量增加一路，反之则减少一路 resource_name String 资源名 mode String 按需或包周期 PACKAGE 包周期 ONDEMAND 按需 version String 资源版本 ENTERPRISE 企业版 ADVANCED 高级版 OTHER 其他 resource_state String 资源状态： NORMAL 正常 ARREARS 欠费 UNAVAILABLE 不可使用冻结 Exp_time String 资源过期时间

响应参数 状态码： 200 表7 响应Body参数 参数 参数类型 描述 failed_num Integer 失败数量 channels Array of ChannelResult objects 通道结果 表8 ChannelResult 参数 参数类型 描述 device_id String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 channel_id String 通道ID： 好望设备：取值范围[0,999] 国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取 result Result object 结果信息 表9 Result 参数 参数类型 描述 code String 错误编码 msg String 错误信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 channels 是 Array of SetChannelRecordAlarmPlanReq objects 设置通道录像计划请求体 表4 SetChannelRecordAlarmPlanReq 参数 是否必选 参数类型 描述 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 channel_id 是 String 通道ID： 好望设备：取值范围[0,999] 国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取 stream_type 否 String 码流类型（目前定为主码流，不用传，为后续需求留用） plans 是 Array of SetChannelRecordAlarmPlan objects 录像计划：列表长度范围[1,21] all_day 否 Boolean 是否全程录像：枚举类型，默认为false，如果为true，time_sections省略（不进行校验） 枚举值： true 是 false 否 time_sections 否 Array of TimeSection objects 通道录像计划时间段，取值范围[1,+∞)。如果all_day字段为空或为false，则字段必填 表5 SetChannelRecordAlarmPlan 参数 是否必选 参数类型 描述 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 是 Integer 预录时间，取值范围[1,59] after_time 是 Integer 延录时间，取值范围[1,59]。advance_time和after_time相加要不超过60s。 表6 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]

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 plans 是 Array of ChannelBindRecordPlan objects 通道设置录像计划 record_type 否 String 录像类型：枚举类型，默认为NORMAL_RECORD。 枚举值： NORMAL_RECORD 标准连续云存 表4 ChannelBindRecordPlan 参数 是否必选 参数类型 描述 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 是否全程录像：枚举类型，默认为false。如果为true，time_sections省略 枚举值： true 是 false 否 time_sections 否 Array of TimeSection objects 通道录像计划时间段：取值范围[1,+∞)。如果all_day字段为空或为false，则字段必填 表5 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]

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 failed_num Integer 失败数量 channels Array of ChannelResult objects 通道结果 表7 ChannelResult 参数 参数类型 描述 device_id String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 channel_id String 通道ID： 好望设备：取值范围[0,999] 国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取 result Result object 结果信息 表8 Result 参数 参数类型 描述 code String 错误编码 msg String 错误信息

请求示例 批量设置通道录像计划 PUT /v1/2562572829***/devices/channels/record-plan{ "plans" : [ { "device_id" : "952352LWXT***", "channel_id" : "0", "all_day" : false, "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" } ] }, { "device_id" : "952352DJNR***", "channel_id" : "0", "all_day" : false, "time_sections" : [ { "day_of_week" : 1, "start_time" : "00:02:00", "end_time" : "00:05:00" } ] } ]}

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

响应示例 状态码： 200 OK {"channels": [{"attrs": [{"attr_code": "storage_day","attr_value": 90}],"device_name": "HoloSens IPC","device_id": "testwl000***","channel_id": "0","channel_state": "OFFLINE","channel_name": "HoloSens IPC","bind_state": "NORMAL"},{"attrs": [{"attr_code": "storage_day","attr_value": 90}],"device_name": "HoloSens SDC-test2","device_id": "210123456SMY***","channel_id": "0","channel_state": "OFFLINE","channel_name": "HoloSens SDC-test2","bind_state": "NORMAL"}],"resource_type_code": "NORMAL","resource_name": "90天连续云存储月套餐","resource_id": "321456789012345678901234567*****","resource_state": "NORMAL","mode": "PACKAGE","total": 12,"invalid_num": 0,"manage_num": 0}

URI GET /v1/{user_id}/resources/{resource_id}/channels 表1 路径参数 参数 是否必选 参数类型 描述 resource_id 是 String 包周期资源ID：32位数字、字母组成 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节 表2 Query参数 参数 是否必选 参数类型 描述 limit 否 Integer 单页内显示记录数：取值范围为[1,300]，不填时默认值为10 offset 否 Integer 偏移量：取值范围为[0,2142147483646]

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 channels Array of ChannelInfo objects 通道列表 resource_type_code String 资源类型编码 MANAGE 视图接入调阅 NORMAL 连续云储存 DATAFLOW 行业数据流 MOTION 动检云存储 resource_name String 资源名称 resource_id String 资源ID resource_state String 资源状态 NORMAL 正常 ARREARS 欠费 UNAVAILABLE 不可使用冻结 mode String 按需或包周期 PACKAGE 包周期 ONDEMAND 按需 total Integer 通道总数 invalid_num Integer 非法通道数 manage_num Integer 管理通道数 表5 ChannelInfo 参数 参数类型 描述 attrs Array of AttributeInfo objects 资源属性 device_name String 设备名称 device_id String 设备id channel_id String 通道id channel_state String 通道状态： UNALLOCATED 未分配 ONLINE 在线 OFFLINE 离线 channel_name String 通道名称，长度取值范围[1,64]个字符 bind_state String 绑定状态 表6 AttributeInfo 参数 参数类型 描述 attr_code String 属性编码 access_number 接入路数 bandwidth 带宽 storage_day 存储天数 attr_value float 属性值

请求示例 用户【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参数 参数 是否必选 参数类型 描述 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 红名单

请求参数 表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 错误码描述信息

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

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