华为云用户手册

URI GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/stream-detail 表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参数 参数 参数类型 描述 stream_num Integer 开启码流数 stream_info Array of StreamInfo objects 各码流信息 max_frame_rate Integer 全帧率 corridor_mode_open Boolean 走廊模式是否开启：枚举类型 枚举值： false 关闭 true 开启 mirror_mode Integer 镜像模式：枚举类型 枚举值： 0 不开启镜像 1 水平镜像 2 垂直镜像 3 水平垂直镜像 variable_bit_rate_open Boolean 动态码率是否开启：枚举类型 枚举值： false 关闭 true 开启 variable_bit_rate Integer 动态码率值正整数 variable_frame_rate_open Boolean 动态帧率是否开启：枚举类型 枚举值： false 关闭 true 开启 variable_frame_rate Integer 动态帧率值正整数 表4 StreamInfo 参数 参数类型 描述 stream_type Integer 码流类型：枚举类型 枚举值： 0 主码流， 1 子码流1 2 子码流2 encode_type String 编码类型：枚举类型 枚举值： H.264 H.265 MJPEG resolution String 分辨率 frame_rate Integer 帧率正整数 bit_rate_type Integer 码率类型（H264/H265生效）：枚举类型 枚举值： 0 定码率 1 变码率 bit_rate Integer 定码率码率值/变码率码率上限 definition String 清晰度（云服务参考值） 枚举值： 4K 2K 1080P 720p D1 CIF QCIF intelligence_encoding_open Boolean 智能编码是否开启(H264/H265生效)：枚举类型 枚举值： false 关闭 true 开启 intelligence_encoding_level Integer 智能编码级别(H264/H265生效)：取值范围[1, 5] slice_encoding_open Boolean 多Slice编码是否开启(H264/H265生效)：枚举类型 枚举值： false 关闭 true 开启 layered_encoding_open Boolean 分层编码是否开启(H264/H265生效)：枚举类型 枚举值： false 关闭 true 开启 profile Integer 编码质量(H264/H265生效) ：枚举类型 H264枚举值： 2 Base profile, 1 Main profile 0 High profile; H265枚举值： 0 Main profile i_frame_interval Integer I帧间隔(H264/H265生效) ：取值范围[1, 500] jpeg_quality Integer Jpeg图像质量(MJPEG生效) ：取值范围[1, 99] bit_rate_mode Integer 定码率类型：枚举类型 枚举值： 1 帧率优先 2 图像质量优先 pic_quality Integer 变码率图像质量：枚举类型 枚举值： 1 最好 2 次好 3 较好 4 一般 5 较差 6 差

响应示例 状态码： 200 OK { "stream_num" : 2, "stream_info" : [ { "stream_type" : 0, "encode_type" : "H.264", "definition" : "2K", "frame_rate" : 30, "bit_rate_type" : 1, "bit_rate" : 2048, "intelligence_encoding_open" : false, "intelligence_encoding_level" : 2, "slice_encoding_open" : true, "layered_encoding_open" : false, "profile" : 0, "i_frame_interval" : 25, "jpeg_quality" : 60, "bit_rate_mode" : 0, "pic_quality" : 1 }, { "stream_type" : 1, "encode_type" : "H.264", "definition" : "D1", "frame_rate" : 30, "bit_rate_type" : 1, "bit_rate" : 1024, "intelligence_encoding_open" : false, "intelligence_encoding_level" : 1, "slice_encoding_open" : true, "layered_encoding_open" : false, "profile" : 0, "i_frame_interval" : 30, "jpeg_quality" : 60, "bit_rate_mode" : 1, "pic_quality" : 1 } ], "max_frame_rate" : 30, "corridor_mode_open" : false, "mirror_mode" : 1, "variable_bit_rate_open" : false, "variable_bit_rate" : 2020, "variable_frame_rate_open" : false, "variable_frame_rate" : 25 }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 targets Array of TargetAdd objects 添加目标ID列表 表6 TargetAdd 参数 参数类型 描述 target_id String 目标ID：目标标识符 name String 目标名称 external_target_id String 用户传入的名单库ID jpegBase64 String 图片内容，经过base64编码 result Result object 结果信息 表7 Result 参数 参数类型 描述 code String 错误编码 msg String 错误信息

请求示例 批量添加目标 POST /v1/2562572829***/targets/batch-add { "device_id":"952352LWXT***", "group_id":2, "targets":[ { "name":"mark", "gender":"male", "age":24, "country":"中国", "nation":"汉", "native":"杭州", "occupation":"工人", "work_no":"124****77", "phone":"15********61", "email":"1*********@qq.com", "domicile":"杭州", "external_target_id":"10", "remark":"无", "jpegBase64":"/9j/4AAQSkZJRgABAQAAAQABAAD..."}] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 group_id 是 Integer 目标库分组ID：非负值，从获取目标库分组接口获取，NVR默认陌生人分组不可以添加目标 targets 是 Array of AddTargetsDto objects 目标数据列表： NVR800和IVS1800：9.1以上版本支持该接口，支持批量添加，最多支持添加20个目标，NVR800的所有图片合计最大为700K，像素大小在1200*1200以内，NVR800在脱敏库中目标无法进行修改 SDC：仅支持单目标添加 storage 否 Boolean 是否保存图片：false-不保存图片，true-保存图片，默认值true，NVR800的不保存图片就会保存到脱敏名单库中，SDC和NVR800修改时改字段不生效 表4 AddTargetsDto 参数 是否必选 参数类型 描述 name 是 String 姓名：支持中英文、数字、特殊字符（_-空格），长度范围[1,128] gender 是 String 性别：枚举类型 枚举值： male 男性 female 女性 age 否 Integer 年龄：取值范围[1,255]（仅NVR800支持） country 否 String 国家：支持大小写字母数字，长度范围[1,128]（SDC不支持） nation 否 String 民族：支持大小写字母数字，长度范围[1,32]（暂不支持） native 否 String 籍贯：支持大小写字母数字，长度范围[1,128]（IVS1800不支持） occupation 否 String 职业：支持大小写字母数字，长度范围[1,128]（SDC不支持） work_no 否 String 工号或身份证号之类：支持大小写数字，长度范围[1,64] phone 否 String 电话：11位纯数字（仅NVR800支持） email 否 String 邮箱：邮箱格式，***@.***（仅NVR800支持） domicile 否 String 居住地：支持大小写字母数字，长度范围[1,256]（IVS1800不支持） remark 否 String 备注信息：支持大小写字母数字，长度范围[1,512]（SDC不支持） jpegBase64 是 String 目标图片：经过base64编码（单个图片建议不超过50K），像素大小在1200*1200以内，支持png、jpeg、jpg格式 external_target_id 否 String 用户传入的目标id：支持大小写英文、数字、_，长度范围[1,64]，NVR800不保存图片必须传external_target_id

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+ CS 5BmInek3OfrSDIQDy+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" }