华为云用户手册

  • 响应参数 状态码: 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
  • 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章节
  • 请求参数 表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
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken:从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 device_org_name 是 String 设备组织名称:支持数字、中文(一个汉字算两个字符)、英文、空格、-、_,长度范围[1,50] parent_org_id 是 String 父级组织ID:由数字组成,长度范围[1,25],可以从查询子级设备组织获取,根节点无法添加子级组织
  • 状态码 返回的状态码参考如下表所示: 表1 状态码 返回值 说明 200 OK 请求正常。 201 Created 创建类的请求完全成功。 202 Accepted 已经接受请求,但未处理完成。 204 No Content 请求完全成功,同时HTTP响应不包含响应体。 400 Bad Request 非法请求。 建议直接修改该请求,不要重试该请求。 401 Unauthorized 在客户端提供认证信息后,返回该状态码,表明服务端指出客户端所提供的认证信息不正确或非法。 403 Forbidden 请求被拒绝访问。 返回该状态码,表明请求能够到达服务端,且服务端能够理解用户请求,但是拒绝做更多的事情,因为该请求被设置为拒绝访问,建议直接修改该请求,不要重试该请求。 404 Not Found 所请求的资源不存在。 建议直接修改该请求,不要重试该请求。 405 Method Not Allowed 请求中带有该资源不支持的方法。 建议直接修改该请求,不要重试该请求。 406 Not Acceptable 服务器无法根据客户端请求的内容特性完成请求。 407 Proxy Authentication Required 请求要求代理的身份认证,与401类似,但请求者应当使用代理进行授权。 408 Request Timeout 服务器等候请求时发生超时。 客户端可以随时再次提交该请求而无需进行任何更改。 409 Conflict 服务器在完成请求时发生冲突。 返回该状态码,表明客户端尝试创建的资源已经存在,或者由于冲突请求的更新操作不能被完成。 500 Internal Server Error 表明服务端能被请求访问到,但是不能理解用户的请求。 501 Not Implemented 服务器不支持请求的功能,无法完成请求。 502 Bad Gateway 充当网关或代理的服务器,从远端服务器接收到了一个无效的请求。 503 Service Unavailable 被请求的服务无效。 建议直接修改该请求,不要重试该请求。 504 Gateway Timeout 网关超时。 父主题: 附录
  • 请求示例 添加摄像机巡航轨迹 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
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken:从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 cruise_type 是 String 巡航轨迹类型:枚举类型 枚举值: CRUISE_TRACK 巡航轨迹,目前仅支持模式,基于预置点的巡航 cruise_name 是 String 巡航轨迹名称:数字、中文、英文、空格、-、_,.,长度范围[1,128] cruise_points 是 Array of CruisePoint objects 预置位列表 表4 CruisePoint 参数 是否必选 参数类型 描述 preset_index 是 Integer 预置点位序号:取值范围[1,255] dwell_time 是 Integer 预置位停留时间:取值范围[30,3600] speed_level 是 Integer 移动速度:取值范围[0,10],0最慢,10最快
  • 响应参数 状态码: 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 属性值
  • 响应示例 状态码: 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 OK { "device_id" : "952352DJNR***", "channel_id" : "0", "all_day" : false, "is_upload_record": true, "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" } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 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 是否全程录像:枚举类型, 如果为true,time_sections省略 枚举值: true 是 false 否 is_upload_record Boolean 是否开启录像缓存补录:枚举类型。可以在web界面远程配置--企业统一配置--断网补录中更改此配置。 枚举值: true 开启 false 关闭 time_sections Array of TimeSection objects 通道录像计划时间段 表4 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] 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码:失败对应具体错误码,成功无 error_msg String 请求失败时为:错误信息,成功无 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码:失败对应具体错误码,成功无 error_msg String 请求失败时为:错误信息,成功无 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码:失败对应具体错误码,成功无 error_msg String 请求失败时为:错误信息,成功无
  • URI GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/record-plan 表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章节
  • 响应示例 状态码: 200 OK { "groups": [ { "name": "ssre2d", "enable": "CLOSE", "group_id": 2, "is_fixed": true, "is_hidden": false } ], "device_id": "952352LWXT***", "group_max_count": 128 }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 groups Array of TargetGroup objects 目标库分组列表 device_id String 设备ID,设备唯一标识符 group_max_count String 最大目标库分组数量限制:-1表示不限制 表5 TargetGroup 参数 参数类型 描述 group_id Integer 目标库分组ID:目标库标识符 name String 目标库名称 enable String 目标库分组是否生效:枚举类型 IVS1800设备该字段不返回,IVS1800目标库均生效 枚举值: OPEN 生效 CLOSE 失效 is_fixed Boolean 是否可修改:true表示该目标库分组详情不可修改,false表示该目标库分组详情可以修改 is_hidden Boolean 是否隐藏:仅NVR有用,白名单返回的true,其他类型的目标库返回的是false
  • URI GET /v1/{user_id}/target-groups 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户ID:由数字组成,长度范围[15,25],获取方式参考获取user ID与下载AK/SK 表2 Query参数 参数 是否必选 参数类型 描述 device_id 是 String 设备ID: 好望设备:大小写字母、数字组成,长度范围[8,32],可在设备外壳或者设备web页面上获取
  • 请求示例 通过版本查询设备能力集 POST /v1/2562572829***/devices/ability { "versions" : [ { "device_type" : "IPC", "model" : "C3050-10-LI-PV(3.6mm)", "firmware" : "SDC 10.0.RC11" }, { "device_type" : "IPC", "model" : "C3050-10-LI-PV(3.6mm)", "firmware" : "SDC 10.0.RC12" } ], "need_specification" : true, "ability" : [ "ptz", "soundlightalarm" ] }
  • 响应示例 状态码: 200 OK { "abilities" : [ { "device_type" : "IPC", "firmware" : "SDC 10.0.RC11", "model" : "C3050-10-LI-PV(3.6mm)", "abilities" : { "ptz" : { "support" : false }, "soundlightalarm" : { "alarm_voice_file_max_num" : "6", "alarm_voice_one_file_max_size" : "76800", "alarm_voice_file_max_size" : "524288", "support" : false } } }, { "device_type" : "IPC", "firmware" : "SDC 10.0.RC12", "model" : "C3050-10-LI-PV(3.6mm)", "abilities" : { "ptz" : { "support" : false }, "soundlightalarm" : { "support" : false } } } ] }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 abilities Array of DeviceVersionAndAbilities objects 设备版本对应能力集返回体 表6 DeviceVersionAndAbilities 参数 参数类型 描述 device_type String 设备类型 model String 设备款型 firmware String 设备软件版本 abilities Object 设备能力集规格
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 否 String 用户认证AccessToken:从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 versions 是 Array of versions objects 设备版本 need_specification 否 Boolean 是否需要返回具体规格,不传默认false ability 否 Array of strings 查询的云上能力集列表,不传默认查询所有能力集 表4 versions 参数 是否必选 参数类型 描述 device_type 是 String 设备类型,必填,可以通过用户根据设备ID查询设备信息详情获取 firmware 是 String 设备软件版本,必填,可以通过用户根据设备ID查询设备信息详情获取 model 是 String 设备固件类型(设备款型),必填,可以通过用户根据设备ID查询设备信息详情获取
  • 响应参数 状态码: 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
  • 请求示例 发起P2P实况连接信息 POST /v1/2562572829***/devices/channels/p2p-connect/live { "channels": [ { "device_id": "952352LWXT***", "channel_id": "123", "stream_type": "PRIMARY_STREAM" }, { "device_id": "952352LWXT***", "channel_id": "123", "stream_type": "SECONDARY_STREAM_1" } ] }
  • 响应示例 状态码: 200 OK { "p2p_connections" : [ { "device_id" : "D123", "token" : "XSab786654", "p2p_nodes" : [ { "address_type" : "IPV4", "address" : [ "123.123.*.*", "lingwai123.123.*.*" ], "tcp_port" : 0, "udp_port" : 7050, "node_type" : "BETTER" } ], "device_state" : "ONLINE", "result" : { "code" : "IVM.0", "msg" : "Success" } }, { "device_id" : "D124", "token" : "XSab786654", "p2p_nodes" : [ { "address_type" : "IPV4", "address" : [ "123.123.*.*", "123.123.*.*" ], "tcp_port" : 0, "udp_port" : 7050, "node_type" : "BETTER" } ], "device_state" : "ONLINE", "result" : { "code" : "IVM.0", "msg" : "Success" } } ], "live_urls" : [ { "device_id" : "D123", "channel_id" : "0", "live_url" : "jvmp://123.123.*.*:***/live/2102412469", "result" : { "code" : "IVM.0", "msg" : "Success" } }, { "device_id" : "D124", "channel_id" : "1", "live_url" : "jvmp://123.123.*.*:***/live/2102412469", "result" : { "code" : "IVM.0", "msg" : "Success" } } ] }
  • 响应参数 状态码: 200 表5 响应Body参数 参数 参数类型 描述 fail_num Integer 获取设备url失败的数量 p2p_connections Array of P2PDevicesResp objects P2P信息列表 live_urls Array of getLiveURLChannelsResp objects 云转发地址列表 request_id String 该请求的id 表6 P2PDevicesResp 参数 参数类型 描述 device_id String 设备ID:设备唯一标识,长度范围[1,32] p2p_nodes Array of P2PMTSListResp objects p2p连接可用节点 device_state String 在线状态:枚举类型 枚举值: OFFLINE 离线 ONLINE 在线 token String P2P请求Token result Result object 错误信息 表7 P2PMTSListResp 参数 参数类型 描述 address Array of strings 媒体转发服务地址: 协议头在SDK封装 ,根据address_type决定地址类型 DOMAIN: www.huawei.com IPV4: 123.123.123.123 IPV6: fe80::f816:3eff:feed:5821 address_type String 地址类型:枚举类型 DOMAIN 域地址 IPV4 IPv4地址 IPV6 IPv6地址 node_type String 节点类型:枚举类型 枚举值: COMMON 普通:普通的三线(移动,联通,电线)服务器,与地域有关,服务器由运营商托管,网络通信质量低 BETTER 优质:全网通服务器(华为云服务器等),网络通信质量高 tcp_port Integer TCP端口:默认值为 0 备注:未使用0端口,tcp_port只作为兼容字段保留 udp_port Integer UDP端口:默认值为 7050 表8 getLiveURLChannelsResp 参数 参数类型 描述 device_id String 设备ID:设备唯一标识,长度范围[1,32] channel_id String 通道ID:长度范围[1,20] live_url String 媒体实况播放地址 result Result object 错误信息 表9 Result 参数 参数类型 描述 code String 错误编码,请参见错误码 msg String 错误信息
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken:从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 channels 是 Array of P2PChannelsLiveParam objects 请求信息 expire_time 否 Integer 自定义Url过期时间:时间范围[30, 86400],不填写时默认值为 30(单位/秒) 备注:仅对live_urls中的live_url有效 use_times 否 Integer 自定义Url使用次数:枚举类型,不填写时默认值为 0 备注:仅对live_urls中的live_url有效 枚举值: 0 使用一次 1 有效时间内任意使用 表4 P2PChannelsLiveParam 参数 是否必选 参数类型 描述 device_id 是 String 设备ID: 好望设备:大小写字母、数字组成,长度范围[8,32],可在设备外壳或者设备web页面上获取 备注:国标协议不支持P2P连接 channel_id 是 String 通道ID: 好望设备:取值范围[0,999] stream_type 是 String 码流类型:枚举类型 枚举值: PRIMARY_STREAM 主码流 SECONDARY_STREAM_1 子码流1 SECONDARY_STREAM_2 子码流2
  • 操作解析 将得到的热度值0~255平均划分成22等分(范围),每个范围对应一种ARGB颜色,得到彩色热度图图片。 热度值和颜色对应关系如下: 热度值 ARGB颜色 0~11 (0, 0, 0, 0) 12~23 (255, 0, 0, 255) 24~34 (255, 0, 51, 255) 35~46 (255, 0, 102, 255) 47~57 (255, 0, 153, 255) 58~69 (255, 0, 204, 255) 70~81 (255, 0, 255, 255) 82~92 (255, 0, 255, 204) 93~104 (255, 0, 255, 153) 105~115 (255, 0, 255, 102) 116~127 (255, 0, 255, 51) 128~139 (255, 0, 255, 0) 140~150 (255, 51, 255, 0) 151~162 (255, 102, 255, 0) 163~173 (255, 153, 255, 0) 174~185 (255, 204, 255, 0) 186~197 (255, 255, 255, 0) 198~208 (255, 255, 204, 0) 209~220 (255, 255, 153, 0) 221~231 (255, 255, 102, 0) 232~243 (255, 255, 51, 0) 244~255 (255, 255, 0, 0)
  • 响应示例 状态码: 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" } ] }
  • 响应参数 状态码: 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 资源过期时间
共100000条