华为云用户手册

URI GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/cruise-track/list 表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参数 参数 参数类型 描述 device_id String 设备ID channel_id String 通道ID cruises_ids Array of GetCruiseTracksItem objects 巡航轨迹ID列表 表4 GetCruiseTracksItem 参数 参数类型 描述 cruises_id Integer 巡航轨迹ID cruises_name String 巡航轨迹名称 enable_cruise String 启停状态，枚举值： OPEN：开启 CLOSE：关闭

URI GET /v1/{user_id}/devices/snap 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节 表2 Query参数 参数 是否必选 参数类型 描述 channel_id 是 String 通道ID： 好望设备：取值范围[0,999] 国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 storage 是 String 是否云存储标识。 枚举值： true 当需要云存储时，接口返回图片的下载URL； false 无需存储时，返回图片base64编码数据。

响应示例 状态码： 200 OK 示例 1 { "pic_url" : "// 当 storage 字段为 false 时，此字段为空串", "pic_data" : "AAAAgAAAAAAAAAAAAAAAgAAAAd+/G0N4rYLasJ08oixRKANqyPxtwopjAcfLZ4vrF3LjwAAAAAAAAAAAAAAsIovJNbDeBeddTigN037AAiOm67Mrvka1Ht8LGT2S8FDAySkfqvCnq+CS5BmInek3OfrSDIQDy+TUImvmwYXjpj3FkYIU+L0GkGD7C6r73YxoZ2ocChqpARrXIzlp/zKi4DpzQ47Ese4IX2zkrLgehpMhE98" } 示例 2 { "pic_url" : "http://api-ivm.myhuaweicloud.com/v1/holo/219123456CYP***_0_210/static", "pic_data" : "// 当 storage 字段为 true 时，此字段为空串" } 示例2中获取到的pic_url的请求示例如下 请求 http://api-ivm.myhuaweicloud.com/v1/holo/219123456CYP***_0_210/static Access-Token: xxx 响应格式1: { "pic_data": "ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234" // base64编码的图片 } 响应格式2: 二进制编码的图片内容

URI GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/targets/authorization 表1 路径参数 参数 是否必选 参数类型 描述 channel_id 是 String 通道ID： 目前只支持好望设备，取值范围[-1,999]。通道id传-1时代表只查询设备本身，传通道id时查设备及通道。 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]

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参数 参数 是否必选 参数类型 描述 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 失效

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

请求示例 批量设置通道存储时间策略请求示例 PUT /v1/2562572829***/devices/channels/time-policy { "channel_time_policies" : [ { "device_id" : "952352LWXT***", "channel_id" : "0", "time_policies" : [ { "storage_days" : 15, "storage_type" : "PLAN_RECORD" }, { "storage_days" : 15, "storage_type" : "MOTION_RECORD" } ] }, { "device_id" : "952352DJNR***", "channel_id" : "1", "time_policies" : [ { "storage_days" : 15, "storage_type" : "PLAN_RECORD" } ] } ] }

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 channel_time_policies 是 Array of ChannelTimePolicy objects 设置设备通道留存期：长度范围[1,100] 表4 ChannelTimePolicy 参数 是否必选 参数类型 描述 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 channel_id 是 String 通道ID： 好望设备：取值范围[0,999] 国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取 time_policies 是 Array of TimePolicy objects 资源储存留存期集合：长度不可为0 表5 TimePolicy 参数 是否必选 参数类型 描述 storage_days 是 Integer (单位：天) 留存期,留存期取值范围：[1,365] storage_type 是 String 留存期类型：计划录像：PLAN_RECORD 动检录像：MOTION_RECORD 枚举值： PLAN_RECORD 计划录像 MOTION_RECORD 动检录像

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 group_id 是 Integer 目标库分组ID：非负值，从获取目标库分组接口获取 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取

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

URI PUT /v1/{user_id}/devices/{device_id}/channels/{channel_id}/cruise-track/enable 表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,+∞)，可以从获取巡航轨迹列表中获取 enable_cruise 是 String 巡航轨迹使能：枚举类型 枚举值： OPEN 启动巡航 CLOSE 停止巡航

响应示例 状态码： 200 OK { "failed_num" : 1, "results" : [ { "device_id" : "952352DJNR***", "result" : { "code" : "IVM.0", "msg" : "Success" } }, { "device_id" : "952352LWXT***", "result" : { "code" : "IVM.10022037", "msg" : "Move device is not exist" } } ] }

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

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 failed_num Integer 移动失败设备数 results Array of northMoveDevicesResult objects 设备移动结果详细信息 表5 northMoveDevicesResult 参数 参数类型 描述 device_id String 设备ID，设备唯一标识符 result ResultInfo object 错误或正确信息 表6 ResultInfo 参数 参数类型 描述 code String 单个结果码 msg String 单个结果信息

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 fail_num Integer 获取设备url失败的数量 channels Array of getLiveURLChannelsResp objects 响应信息 request_id String 该请求的记录id 表6 getLiveURLChannelsResp 参数 参数类型 描述 device_id String 设备ID：设备唯一标识，长度范围[1,32] channel_id String 通道ID：长度范围[1,20] live_url String 媒体实况播放地址：将此url输入播放地址栏开始播放 result Result object 错误信息 表7 Result 参数 参数类型 描述 code String 错误编码：请参见错误码 msg String 错误信息

请求示例 查询通道实况播放地址 POST /v1/2562572829***/devices/channels/cloud-live/url { "channels": [ { "device_id": "952352LWXT***", "channel_id": "0", "live_protocol": "HOLO", "stream_type": "PRIMARY_STREAM" }, { "forbid_audio":1, "device_id": "952352DJNR***", "channel_id": "0", "live_protocol": "HLS", "stream_type": "PRIMARY_STREAM" }, { "device_id": "952352DJNR***", "channel_id": "0", "live_protocol": "HLS_HTTPS", "stream_type": "PRIMARY_STREAM" }] }

响应示例 状态码： 200 OK { "fail_num": 0, "channels": [ { "device_id": "952352LWXT***", "channel_id": "0", "live_url": "jvmp://123.123.*.*:***/live/952352LWXT***?token=...", "result": { "code": "IVM.0", "msg": "Success" } }, { "device_id": "952352DJNR***", "channel_id": "0", "live_url": "http://123.123.*.*:***/live/live.m3u8?token=...&device_id=952352DJNR***&channel_id=0&stream_type=0&forbid_audio=1", "result": { "code": "IVM.0", "msg": "Success" } }, { "device_id": "952352DJNR***", "channel_id": "0", "live_url": "https://123.123.*.*:***/live/live.m3u8?token=...&device_id=952352DJNR***&channel_id=0&stream_type=0", "result": { "code": "IVM.0", "msg": "Success" } } ], "request_id": "0e3515f7-4c5e-497f-abb8-4541d6963dd2" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 channels 是 Array of GetLiveURLChannelsParam objects 通道列表 expire_time 否 Integer 自定义Url过期时间：时间范围[30, 86400]，不传默认为 30（单位/秒） 备注：仅对channels中的live_url有效 use_times 否 Integer 自定义Url使用次数：枚举类型，不填写时默认值为 0，RTSP协议固定为 0 备注：仅对channels中的live_url有效 枚举值： 0 使用一次 1 有效时间内任意使用，此参数对RTSP协议无效 表4 GetLiveURLChannelsParam 参数 是否必选 参数类型 描述 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度固定为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 channel_id 是 String 通道ID： 好望设备：取值范围[0,999] 国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取 live_protocol 是 String 媒体播放协议：枚举类型，选择获取地址的媒体播放协议类型 枚举值： HOLO 好望协议 HLS 基于HTTP的HLS流媒体传输协议 HLS_HTTPS 基于HTTPS的HLS流媒体传输协议 HTTP_FLV 基于HTTP的FLV媒体协议 HTTPS_FLV 基于HTTPS的FLV媒体协议 RTSP RTSP流媒体传输协议 stream_type 是 String 码流类型：枚举类型 枚举值： PRIMARY_STREAM 主码流 SECONDARY_STREAM_1 子码流1 SECONDARY_STREAM_2 子码流2 forbid_audio 否 Integer 禁用音频选项：不填写默认值为 0 备注：只针对HLS有效，推荐微信小程序端使用禁用音频选项 枚举值： 0 不禁用音频 1 禁用音频 trans_protocol 否 String 传输协议：枚举类型，不填写时默认值为 TCP，仅适用于gb28181，其它接入协议无效 枚举值： TCP TCP传输协议 UDP UDP传输协议

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述消息管理 failed_num Integer 请求失败的错误数量 alarms Array of AlarmPictureUrlsResAlarm objects 响应信息 表5 AlarmPictureUrlsResAlarm 参数 参数类型 描述 alarm_uuid String 告警id url String 告警图片网络下载路径，该路径有效期为五分钟 targetgroup_url String 目标组图片网络下载路径，该路径有效期为五分钟，如果没有该图片则返回空 result AlarmPictureUrlReqResult object 响应信息 表6 AlarmPictureUrlReqResult 参数 参数类型 描述 code String 错误码 msg String 错误码描述

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证token，从获取用户认证token接口获取 表3 请求Body参数 参数 是否必选 参数类型 描述 alarm_classification 否 String 告警分类： INTELLIGENT（移动智能告警，包括移动侦测和周界告警） TARGET （目标智能告警） TARGET_DET （口罩告警） CROWD（人群态势告警） THIRD_PARTY / THIRDPARTY_INTELLIGENT（第三方智能告警） 该字段已弃用，客户只需要传入正确的alarm_uuids即可 alarm_uuids 是 Array of strings 告警的alarm_uuid数组：alarm_uuid是告警信息的唯一标识，每条告警信息都拥有该属性，包含在消息管理配置的通知URL推送的告警消息体中，从设备智能告警消息中查阅，数组长度[1,100] 由产生该条告警的设备ID，通道ID，告警的消息类型和时间等信息组成。例如：2000000000WLL0000001_0_target_alarm_20060102150405_0

响应示例 状态码： 200 接口响应 { "failed_num": 0, "alarms": [ { "alarm_uuid": "HOLOIPCALARM53200_0_people_count_line_alarm_20230220201831_17", "url": "http://123.123.123.123:31012/v1/holo/HOLOIPCALARM53200_0_people_count_line_alarm_20230220201831_17.jav?secret=lln7Rnpg6sS%2BvUp%2BD%2FPHKCpbsVhg&type=0&expire=1676926267&extend=0", "targetgroup_url": "", "result": { "code": "IVM.0", "msg": "success" } } ] }

URI GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/device-records/playback-url 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节 device_id 是 String 设备ID： 国标设备：由数字组成，长度固定为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 channel_id 是 String 通道ID： 国标设备：由数字组成，长度为20个字符，由客户自行在设备侧设置，可以在web界面获取 表2 Query参数 参数 是否必选 参数类型 描述 start_time 是 String 开始时间：格式如：yyyy-MM-dd HH:mm:ss end_time 是 String 结束时间：格式如：yyyy-MM-dd HH:mm:ss playback_protocol 否 String 媒体播放协议：枚举类型，选择获取地址的媒体播放协议类型，不填写时默认值为 HOLO 枚举值： HOLO 好望协议 expire_time 否 String 自定义Url过期时间：时间范围[30, 86400]，不传默认为 30（单位/秒） 备注：仅对响应Body参数中的playback_url有效 use_times 否 String 自定义Url使用次数：枚举类型，不填写时默认值为 0 备注：仅对响应Body参数中的playback_url有效 枚举值： 0 使用一次 1 有效时间内任意使用 trans_protocol 否 String 传输协议：枚举类型，不填写时默认值为 TCP，仅适用于gb28181，其它接入协议无效 枚举值： TCP TCP传输协议 UDP UDP传输协议 stream_type 否 String 码流类型：枚举类型，不填写时默认值为 PRIMARY_STREAM 枚举值： PRIMARY_STREAM 主码流 SECONDARY_STREAM_1 子码流1 SECONDARY_STREAM_2 子码流2

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