华为云用户手册

响应示例 状态码： 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 表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 差

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参数 参数 参数类型 描述 abilities Array of StreamAbilityItem objects 码流能力列表 channel_no Integer 视频通道ID is_support_corridor_mode Boolean 是否支持走廊模式 is_support_water_mark Boolean 是否支持水印，取值范围：true – 支持；false – 不支持 mirror_mode MirrorMode object 镜像模式 variable_bit_rate VariableBitRate object 动态码率 variable_frame VariableFrame object 动态帧率 h264_info EncodeInfo object H264编码信息 h265_info EncodeInfo object H265编码信息 mjpeg_info EncodeInfo object MJPEG编码信息 digital_zoom_info DigitalZoomInfo object 数字变倍信息 roi_info ROIInfo object ROI（感兴趣区域）信息 vo_info VOInfo object VO模拟输出能力 osd_info OSDInfo object OSD信息 is_hide_sub_stream_for_main_mjpeg Boolean 主码流MJPEG开启时是否隐藏子码流 表4 StreamAbilityItem 参数 参数类型 描述 stream_count Integer 码流数量 max_frame_rate Integer 最大帧率 stream_info Array of StreamInfo objects 码流信息 表5 StreamInfo 参数 参数类型 描述 stream_type Integer 码流类型：枚举类型 枚举值： 0 主码流， 1 子码流1 2 子码流2 encode_mode Array of EncodeMode objects 编码信息列表 support_crop Boolean 是否支持裁剪：枚举类型 枚举值： false 不支持 true 支持 support_eptz Boolean 是否支持电子云台：枚举类型 枚举值： false 不支持 true 支持 表6 EncodeMode 参数 参数类型 描述 type String 编码类型：枚举类型 枚举值： H.264 H.265 MJPEG resolution Array of Resolution objects 分辨率列表 表7 Resolution 参数 参数类型 描述 type String 分辨率长和宽为数字，通过*分隔 frame_rate Array of integers 帧率列表 bit_rate BitRate object 该分辨率对应的码率信息 表8 BitRate 参数 参数类型 描述 support Boolean 该分辨率对应的是否支持码率配置* begin Integer 该分辨率对应的码率最小值* end Integer 该分辨率对应的码率最大值* default Integer 该分辨率对应的码率默认值* 表9 MirrorMode 参数 参数类型 描述 support Boolean 是否支持镜像模式：枚举类型 枚举值： false 关闭 true 开启 type Array of integers 镜像类型：枚举类型 枚举值： 0 不开启镜像 1 水平镜像 2 垂直镜像 3 水平垂直镜像 表10 VariableBitRate 参数 参数类型 描述 support Boolean 是否支持动态码率：枚举类型 枚举值： false 关闭 true 开启 表11 VariableFrame 参数 参数类型 描述 support Boolean 是否支持动态帧率：枚举类型 枚举值： false 关闭 true 开启 表12 EncodeInfo 参数 参数类型 描述 intelligence Intelligence object 智能编码信息 is_support_slice Boolean 是否支持多Slice编码 is_support_layered_encoding Boolean 是否支持分层编码 profile_list ProfileList object 编码复杂度类型 i_frame_interval IFrameInterval object I帧间隔 bit_rate_info BitRateInfo object 码率信息 jpeg_quality JpegQuality object jpeg质量 表13 Intelligence 参数 参数类型 描述 support Boolean 是否支持智能编：枚举类型 枚举值： false 关闭 true 开启 type Array of integers 支持智能编码类型 表14 ProfileList 参数 参数类型 描述 support Boolean 是否支持编码复杂度类型：枚举类型 枚举值： false 关闭 true 开启 type Array of integers 枚举类型 H264编码枚举值： 0 High profile， 1 Main profile 2 Base profile H264编码枚举值： 0 Main profile 表15 IFrameInterval 参数 参数类型 描述 support Boolean 是否支持I帧间隔：枚举类型 枚举值： false 关闭 true 开启 begin Integer I帧间隔最小值 end Integer I帧间隔最大值 表16 BitRateInfo 参数 参数类型 描述 support Boolean 是否支持：枚举类型 枚举值： false 关闭 true 开启 bit_rate_type Array of BitRateType objects 码率类型：枚举类型 枚举值： 0 定码率 1 变码率 表17 JpegQuality 参数 参数类型 描述 begin Integer jpeg质量最小值：1 end Integer jpeg质量最大值：99 表18 BitRateType 参数 参数类型 描述 type Integer 码率类型 bit_rate_mode Array of integers 定码率类型：枚举类型 枚举值： 1 帧率优先 2 图像质量优先 pic_quality Array of integers 变码率图像质量：枚举类型 枚举值： 1 最好 2 次好 3 较好 4 一般 5 较差 6 差 表19 DigitalZoomInfo 参数 参数类型 描述 max_zoom Integer 数字变倍支持的最大倍率 support Boolean 是否支持数字变倍 表20 ROIInfo 参数 参数类型 描述 support Boolean 是否支持感兴趣区域编码：枚举类型 枚举值： false 关闭 true 开启 roi_quality ROIQuality object 感兴趣区域编码质量能力对象 表21 ROIQuality 参数 参数类型 描述 begin Integer 最小值 end Integer 最大值 表22 VOInfo 参数 参数类型 描述 param VOInfoParam object 参数 support Boolean 是否支持模拟输出能力：枚举类型 枚举值： false 关闭 true 开启 表23 VOInfoParam 参数 参数类型 描述 channel_no String 通道号 表24 OSDInfo 参数 参数类型 描述 support Boolean 是否支持OSD：枚举类型 枚举值： false 关闭 true 开启

URI GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/stream-ability 表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参数 参数 是否必选 参数类型 描述 current_security_key 是 String 设备当前密码：初始化设置密码时可不填 new_security_key 是 String 设备新密码：字符组成（大写字母、小写字母、数字、特殊字符至少两项，且不能与用户名或用户名的倒序相同），长度范围[8,20]

URI PUT /v1/{user_id}/devices/{device_id}/channels/{channel_id}/security-key 表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 GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/security-key 表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}/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 停止巡航

URI PUT /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 请求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最快

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

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

请求参数 表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 { "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,+∞)，可以从获取巡航轨迹列表中获取

响应示例 状态码： 200 OK { "device_id" : "952352LWXT***", "targets" : [ { "name" : "mark", "gender" : "male", "age" : 24, "country" : "中国", "nation" : "汉", "native" : "杭州", "occupation" : "工人", "work_no" : "124****77", "phone" : "15********61", "email" : "1*********@qq.com", "domicile" : "杭州", "remark" : "无", "jpegBase64" : "/9j/4AAQSkZJRgABAQAAAQABAAD...", "target_id" : "2", "external_target_id" : "1234567890123***" } ] }

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 device_id String 设备ID：设备唯一标识符 targets Array of TargetVo objects 目标信息列表（SDC不返回图片） 表5 TargetVo 参数 参数类型 描述 target_id String 目标ID：目标标识符 name String 姓名 gender String 性别 age Integer 年龄 country String 国家 nation String 民族 native String 籍贯 occupation String 职业 organization String 组织名称 work_no String 工号或身份证号 phone String 电话 email String email domicile String 居住地 remark String 备注 eigen_value String 图片特征值 jpg String 图片内容：经过base64编码 start_time String 开始时间 end_time String 结束时间 external_target_id String 用户传入的目标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：关闭

请求参数 表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参数 参数 是否必选 参数类型 描述 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

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