华为云用户手册

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

请求示例 查询前端的录像回放地址 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" : "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_GRANT 客流客群服务未开通 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 更新时间

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

响应示例 状态码： 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 OK { "device_id": "952352LWXT***", "device_name": "测试设备", "device_state": "ONLINE", "access_protocol": "HOLO", "device_type": "IPC", "device_system_state": "NORMAL", "description": "test", "model": "JVS-N71-HD", "manufacture": "JOVISION", "channel_total": 10, "stream_total": 2, "firmware": "V1.0", "device_ability" : "ptz,talk", "device_cloud_ability": { "alarm_voice": { "support": "true" }}, "create_time": "2020-06-26 20:42:16", "update_time": "2020-06-26 20:42:16", "protocol_version": "2.0.0", "mac": "xxx", "device_ip": "xxx.xxx.xxx.xxx", "device_port": "8090", "device_org_id": "1234567890***", "device_org_name": "测试组织***", "operator_total": "2", "sdk_ability": "***", "sn": "952352LWXT***" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 Query参数 参数 是否必选 参数类型 描述 ability 否 Array of strings 查询的能力集列表：不传默认查询所有能力集，数组长度范围[0,10]。能力集对应能力参考设备能力集。 need_cloud_ability 否 Boolean 是否需要返回云上管理的能力集：false，不返回云上能力集信息；true，返回云上能力集信息。不填默认false need_specification 否 Boolean 是否需要能力规格：false，不返回能力规格；true，返回能力规格。不填默认false

URI GET /v1/{user_id}/devices/{device_id} 表1 路径参数 参数 是否必选 参数类型 描述 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 表4 响应Body参数 参数 参数类型 描述 mac String 设备mac地址 device_id String 设备ID，设备唯一标识符，如：2102412969WLMB002258 device_name String 设备名称 device_state String 设备状态 枚举值： OFFLINE 离线 ONLINE 在线 UNREGISTERED 未注册 access_protocol String 接入类型 枚举值： GB28181 国标 HOLO 好望 device_type String 设备类型 枚举值： IPC 通用相机 NVR NVR设备 MEdge IVS1800设备 IPC-BULLET 枪机 IPC-BOX 筒机 IPC-CONCH 半球/海螺 IPDOME 球机 device_system_state String 设备系统冻结 枚举值： NORMAL 正常 UNAVAILABLE_FROZEN 冻结 description String 设备描述 model String 设备型号，如：D2150 manufacture String 生产厂商，如：HUAWEI channel_total Integer 通道总数 stream_total Integer 每个通道码流数量 firmware String 摄像头固件版本号 device_ability String 设备能力集：枚举类型，参考附录设备能力集，多个能力集用逗号分隔 device_cloud_ability Object 云端能力集规格 create_time String 创建时间 update_time String 更新时间，在设备重新上线后或者移动设备分组后会修改时间 protocol_version String 设备与平台接入协议版本，如：2.0.0 device_ip String 设备IP device_port String 设备端口 device_org_id String 设备组织ID sn String SN号，等于device_id——设备ID，设备唯一标识符 device_org_name String 设备所处的设备组织名称 operator_total String 操作员总数 sdk_ability String sdk能力集

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 callback_url String 支持http/https协议，最大长度为256英文字符 create_time String 创建时间 update_time String 更新时间 subscription_type String 订阅类型字段， 枚举值： DEVICE_ALARM 智能告警消息（含第三方告警），该消息的数据推送结构体设备智能告警消息结构体 DEVICE_EXCEPTION 设备异常消息，该消息的数据推送结构体设备异常告警消息结构体 DEVICE_UNBIND 设备解绑、套餐解绑数据，该消息的数据推送结构体设备解绑消息结构体 TARGET_DATA 目标TLV数据，该消息的数据推送结构体目标数据消息结构体 THIRD_DATA 第三方TLV数据，该消息的数据推送结构体三方数据消息结构体 VEHICLE_DATA 机非人TLV数据，该消息的数据推送结构体机非人消息结构体 HEAD_SHOULDER_DATA 头肩业务TLV数据，该消息的数据推送结构体头肩业务消息结构体 BEHAVIOR_ANALYSIS_DATA 行为分析TLV数据，该消息的数据推送结构体行为分析与人车物分离消息结构体 MICRO_CHECKPOINT_DATA 微卡口TLV数据，该消息的数据推送结构体微卡口数据推送结构体 auth_key String 鉴权密钥

响应示例 当URL存在时： { "callback_url": "http://xxxxxx:xx", "subscription_type": "DEVICE_ALARM", "create_time": "2021-03-30 14:34:50", "update_time": "2021-03-30 15:34:50", "auth_key": "xxxxxxx" } 当URL不存在时： {}

URI GET /v1/{user_id}/messages/callback 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节 表2 Query参数 参数 是否必选 参数类型 描述 subscription_type 是 String 订阅类型字段 枚举值： DEVICE_ALARM 智能告警消息（含第三方告警），该消息的数据推送结构体设备智能告警消息结构体 DEVICE_EXCEPTION 设备异常消息，该消息的数据推送结构体设备异常告警消息结构体 DEVICE_UNBIND 设备解绑、套餐解绑数据，该消息的数据推送结构体设备解绑消息结构体 TARGET_DATA 目标TLV数据，该消息的数据推送结构体目标数据消息结构体 THIRD_DATA 第三方TLV数据，该消息的数据推送结构体三方数据消息结构体 VEHICLE_DATA 机非人TLV数据，该消息的数据推送结构体机非人消息结构体 HEAD_SHOULDER_DATA 头肩业务TLV数据，该消息的数据推送结构体头肩业务消息结构体 BEHAVIOR_ANALYSIS_DATA 行为分析TLV数据，该消息的数据推送结构体行为分析与人车物分离消息结构体 MICRO_CHECKPOINT_DATA 微卡口TLV数据，该消息的数据推送结构体微卡口数据推送结构体

响应示例 状态码： 200 OK { "device_id" : "952352LWXT***", "channel_id" : "1", "cruises_id" : 1, "cruise_type" : "CRUISE_TRACK", "cruise_name" : "巡航轨迹名称", "cruise_points" : [ { "preset_index" : 1, "dwell_time" : 30, "speed_level" : 2, "jpg_base64" : "133443" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 device_id String 设备ID channel_id String 通道ID cruises_id Integer 巡航轨迹ID cruise_type String 巡航轨迹类型，枚举值： CRUISE_TRACK 巡航轨迹 MODEL_TRACK 模式轨迹 PAN_TRACK 水平轨迹 TILT_TRACK 垂直轨迹 说明： 目前设备只有CRUISE_TRACK模式——基于预置点的巡航，当处于其他模式时，设备还是按照CRUISE_TRACK模式在实现。 cruise_name String 巡航轨迹名称 cruise_points Array of CruisePointItem objects 巡航轨迹中的预置点列表 表5 CruisePointItem 参数 参数类型 描述 preset_index Integer 预置位序号 dwell_time Integer 预置位停留时间 speed_level Integer 移动速度 jpg_base64 String jpg图片

URI GET /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 Query参数 参数 是否必选 参数类型 描述 cruises_id 是 Integer 巡航轨迹ID：取值范围[1,+∞)，可以从获取巡航轨迹列表中获取

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 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] speed_level 是 Integer 移动速度：取值范围[0,10]，0最慢，10最快

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

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

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

请求参数 表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" } ] } ] }

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

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

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