华为云用户手册

URI GET /v1/{user_id}/devices 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节 表2 Query参数 参数 是否必选 参数类型 描述 access_protocol 否 String 接入协议：枚举类型，多个使用英文逗号分隔 枚举值： HOLO 好望协议 GB28181 国标协议 device_name 否 String 模糊查询字段：支持设备名称模糊匹配，由字符组成，支持数字、中文（一个汉字算两个字符）、英文、-、_、空格，长度范围[0,128] device_state 否 String 设备状态：枚举类型，多个查询使用英文逗号分隔 枚举值： OFFLINE 离线 ONLINE 在线 UNREGISTERED 未注册 device_system_state 否 String 设备系统状态：枚举类型，多个查询使用英文逗号分隔 枚举值： NORMAL 正常 UNAVAILABLE_FROZEN 冻结 device_type 否 String 设备类型：枚举类型，多个查询使用英文逗号分隔 枚举值： IPC 直连摄像机 NVR NVR设备 MEdge IVS1800设备 ability 否 Array of strings 查询的能力集列表：不传默认查询所有能力集，数组长度范围[0,10]。能力集对应能力参考设备能力集。 need_cloud_ability 否 Boolean 是否需要返回云上管理的能力集：false，不返回云上能力集信息；true，返回云上能力集信息。不填默认false need_specification 否 Boolean 是否需要能力规格：false，不返回能力规格；true，返回能力规格。不填默认false direction 否 String 排序方向：枚举类型，默认降序，不区分大小写 枚举值： ASC 升序 DESC 降序 limit 否 Integer 限制条数：取值范围[0,1000]，不填写时默认值为10 offset 否 Integer 偏移量页数：0为第一页，取值范围[0,2147483646]，不填写时默认为0，同时offset*limit需小于2147483646 sort_by 否 String 排序字段：枚举类型，默认按创建时间create_time排序 枚举值： create_time 创建时间 update_time 更新时间

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

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

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

URI GET /v1/{user_id}/device-orgs/tree 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节 表2 Query参数 参数 是否必选 参数类型 描述 device_org_name 是 String 设备组织名称：支持数字、中文（一个汉字算两个字符）、英文、空格、-、_，长度范围[1,50]

响应示例 状态码： 200 OK { "result" : [ { "enterprise_id" : "1230488562***", "device_org_id" : "1357924680***", "device_org_name" : "研发", "parent_id" : "1234567890***", "device_org_level" : 2, "is_leaf" : 0, "is_result" : 1, "camera_count" : 0, "camera_online_count" : 0, "children" : [ { "children" : [ ], "enterprise_id" : "1230488562***", "device_org_id" : "1357924680***", "device_org_name" : "Name", "parent_id" : "1234567890***", "device_org_level" : 2, "is_leaf" : 1, "is_result" : 1, "camera_count" : 0, "camera_online_count" : 0 } ] } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 result Array of QueryDeviceOrgTreeVo objects 响应信息 表5 QueryDeviceOrgTreeVo 参数 参数类型 描述 enterprise_id String 企业ID，企业唯一标识符 device_org_id String 设备组织ID device_org_name String 设备组织名称 parent_id String 上级设备组织ID device_org_level Integer 设备组织级别，第一级子节点数值为1，第二级为2，以此类推 is_leaf Integer 是否是叶子节点：枚举类型 枚举值： 1 叶子节点，没有子级设备组织 0 非叶子节点，有子级设备组织 is_result Integer 是否是查询结果 camera_count Integer 设备数量 camera_online_count Integer 在线设备数量 children Array of query_device_org_tree_children objects 子组织信息 表6 query_device_org_tree_children 参数 参数类型 描述 device_org_id String 设备组织ID device_org_level Integer 设备组织级别，第一级子节点数值为1，第二级为2，以此类推 device_org_name String 设备组织名称 enterprise_id Integer 企业ID，企业唯一标识 is_leaf Integer 是否是叶子节点：枚举类型 枚举值： 1 叶子节点，下没有子级设备组织 0 非叶子节点，下有子级设备组织 is_result Integer 是否是查询结果 parent_id String 上级设备组织ID camera_count Integer 设备数量 camera_online_count Integer 在线设备数量 children Array of query_device_org_tree_children objects 子组织信息

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

响应参数 状态码： 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 单个结果信息

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

URI DELETE /v1/{user_id}/device-orgs/{device_org_id} 表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_org_name 是 String 设备组织名称：支持数字、中文（一个汉字算两个字符）、英文、空格、-、_，长度范围[1,50] parent_org_id 是 String 父级组织ID：由数字组成，长度范围[1,25]，可以从查询子级设备组织获取，根节点无法添加子级组织

URI PUT /v1/{user_id}/device-orgs/{device_org_id} 表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_org_name 是 String 设备组织名称：支持数字、中文（一个汉字算两个字符）、英文、空格、-、_，长度范围[1,50]。可以从查询子级设备组织、查询企业下组织的设备列表中获得

响应示例 状态码： 200 OK { "devices" : [ { "device_id" : "952352LWXT***", "device_name" : "好望设备", "device_state" : "UNREGISTERED", "device_type" : "IPC", "device_system_state" : "NORMAL", "access_protocol" : "HOLO", "manufacture" : "HUAWEI", "device_ability" : "ptz", "channel_total" : "1", "channels" : [ { "channel_resource_state" : [ "MANAGEMENT_GRANT", "INDUSTRY_DATA_GRANT", "FULL_RECORD_GRANT", "EVENT_RECORD_CLOSED" ], "channel_state" : "ONLINE", "channel_system_state" : "NORMAL", "channel_id" : "0", "channel_name" : "好望通道", "invalid_type" : "NORMAL" } ], "operator_total" : "0", "create_time" : "2020-09-01 17:09:12", "update_time" : "2020-12-30 09:30:31", "device_org_name" : "好望设备组" } ], "total" : 1, "device_total" : 1, "admin_total" : 0, "online_total" : 0 }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 devices Array of InnerDeviceInfoMuti objects 设备列表 total Integer 查询条数 device_total Integer 设备总数 admin_total Integer 管理员总数 online_total Integer 在线设备数 表5 InnerDeviceInfoMuti 参数 参数类型 描述 device_id String 设备ID，设备唯一标识符 device_name String 设备名称 device_state String 设备状态 枚举值： OFFLINE 离线 ONLINE 在线 UNREGISTERED 未注册 device_type String 设备类型 枚举值： IPC 直连摄像机 NVR NVR设备 MEdge IVS1800设备 device_system_state String 设备系统冻结 枚举值： NORMAL 正常 UNAVAILABLE_FROZEN 冻结 access_protocol String 接入协议类型 枚举值： HOLO 好望协议 GB28181 国标协议 manufacture String 生产厂家 device_ability String 设备能力集：枚举类型，参考附录设备能力集，多个能力集用英文逗号分隔 channel_total Integer 通道总数 channels Array of InnerChannelInfo objects 通道信息 operator_total Integer 该设备绑定的普通用户总数 model String 设备型号 create_time String 设备添加时间 update_time String 设备更新时间，在设备重新上线后或者移动设备分组后会修改时间 device_org_name String 设备组织名称 frimware String 设备版本 channel_allocated_total Integer 已分配通道总数 channel_online_count Integer 在线通道总数 audio_input_cnt Integer 音频输入通道个数 audio_output_cnt Integer 音频输出通道个数 gb_access_state String 国标设备未上线原因 枚举值 NOT_CONNECTED：云服务未收到设备信息 NO_AUTHENTICATION_INFO：云服务接受设备信息不全 AUTHENTICATION_FAILED：鉴权失败 CATA LOG _ERROR：未收到正确的通道信息 UNKNOWN_ERROR：未知错误 CONNECTED：已连接 表6 InnerChannelInfo 参数 参数类型 描述 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 行业数据流套餐关闭 channel_state String 通道状态：枚举类型 枚举值： OFFLINE 离线 ONLINE 在线 UNREGISTERED 未注册 channel_system_state String 设备系统状态：枚举类型 枚举值： NORMAL 正常 UNAVAILABLE_FROZEN 冻结 channel_id String 通道ID channel_name String 通道名称 channel_model String 通道的设备型号 channel_mode String 通道的设备型号，此字段已废弃，不推荐使用，建议使用channel_model字段代替 invalid_type String 通道无效类型：枚举类型 枚举值： NORMAL 正常 CHANNEL_ID_INVALID 通道ID无效 channel_ability String 通道能力集 storage_card_status String SD卡状态 枚举类型： 0-卡存在且运行正常 1-卡存在但是异常需要格式化 2-卡不存在 3-格式化中 -1-设备不支持 mask_mode String 隐私遮蔽开关状态 枚举类型： OPEN-开 CLOSE-关

URI GET /v1/{user_id}/device-orgs/{device_org_id}/devices 表1 路径参数 参数 是否必选 参数类型 描述 device_org_id 是 String 设备组织ID：由数字组成，长度范围[1,25]，根组织节点的值为0，可以从查询子级设备组织获取 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节 表2 Query参数 参数 是否必选 参数类型 描述 access_protocol 否 String 接入协议：枚举类型，多个查询使用英文逗号分隔 枚举值： HOLO 好望协议 GB28181 国标协议 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 行业数据流套餐关闭 ability 否 String 设备能力：枚举类型，仅支持单个能力集查询 枚举值： algorithm 算法能力 ptz 云台能力 device_id 否 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 国标设备：由数字组成，长度为20个字符长度，由客户自行设置，其中第11-13位，必须是以下之一132（IPC）、111（DVR）、118（NVR)，用来区分设备类型 device_name 否 String 模糊查询字段：支持设备名称模糊匹配，由字符组成，支持数字、中文（一个汉字算两个字符）、英文、-、_、空格，长度范围[1,128] device_state 否 String 设备状态：枚举类型，多个查询使用英文逗号分隔 枚举值： OFFLINE 离线 ONLINE 在线 UNREGISTERED 未注册 device_system_state 否 String 设备系统状态：枚举类型，多个查询使用英文逗号分隔 枚举值： NORMAL 正常 UNAVAILABLE_FROZEN 冻结 device_type 否 String 设备类型：枚举类型，多个查询使用英文逗号分隔 枚举值： IPC 直连摄像机 NVR NVR设备 MEdge IVS1800设备 direction 否 String 排序方向：枚举类型，默认降序，不区分大小写 枚举值： ASC 升序 DESC 降序 group_ids 否 String 所属分组ID列表：支持多个设备组织查询，使用英文逗号分隔 单个设备组织ID：由数字组成，长度范围[1,25]（根组织节点的值为0） is_current_org 否 String 是否属于当前组织：枚举类型，不填就是查询全部组织 枚举值： 0 下级组织 1 当前组织 2 所有组织 limit 否 Integer 限制条数：取值范围[0,1000]，不填写时默认值为10 manufactures 否 String 厂商：支持多个厂商查询，使用英文逗号隔开 单个厂商：由中文（一个汉字算两个字符）、英文、数字 、特殊字符（_-空格）组成，长度范围[1,64] offset 否 Integer 偏移量页数：0为第一页，取值范围[0,2147483646]，不填写时默认为0 sort_by 否 String 排序字段：枚举类型，默认按创建时间create_time排序 枚举值： create_time 创建时间 update_time 更新时间 operator_total 拥有该设备的普通用户总数 user_order 否 Integer 排序字段：枚举类型，按用户数排序（当前无效） 枚举值： 0 数量从小到大 1 数量从大到小

修订记录 表1 修订记录 修改时间 修改说明 2023-08-24 第六十一次正式发布 本次变更如下： 9、10 敏感数据脱敏 隐藏文档中涉及token、user_id、设备ID、AKSK、BASE64数据、图片等敏感信息 2023-08-22 第六十次正式发布 本次变更如下： 12.1批量开通设备通道服务 请求和响应示例的假数据添加***脱敏处理 12.2批量关闭设备通道服务 请求和响应示例的假数据添加***脱敏处理 2023-08-16 第五十九次正式发布 本次变更如下： 6.7批量添加设备 表4里面的algorithm行的描述列新增了md5使用的风险说明 批量变更IP地址为123.123.123.123 批量变更不对外公开地址为www.example.com 2023-07-25 第五十八次正式发布 本次变更如下： 8.5云台控制：表3里面的mode行的描述列做了点动模式的描述新增以及转动模式的描述更改 2023-07-1 第五十七次正式发布 本次变更如下： 替换 好望云服务 为行业视频管理服务。 2023-06-26 第五十六次正式发布 本次变更如下： 修正 SDK中心 链接地址。 9.3获取回放地址统一接口响应结构与字段更正 9.4批量删除播放地址接口功能介绍修改 11.5请求参数中的record_type去掉了枚举值all 19.1请求示例字段更正 2023-06-02 第五十五次正式发布 本次变更如下： 6.4章节请求参数modify_type描述修改 6.5和6.7章节请求参数device_name和device_password描述修改 6.6和6.7章节请求参数description描述修改 7.1章节功能描述修改 9.1新增获取实况地址统一接口 9.2新增查询回放列表统一接口 9.3新增获取回放地址统一接口 9.4章节接口功能描述修改 9.5-9.12章节相应接口更迭为旧接口，加上【旧】字样 9.5-9.12章节功能描述修改，各种参数描述部分修正 10.1章节部分告警描述修改补充，部分TLV字段描述修改补充 2023-02-13 第五十四次正式发布 本次变更如下： 5.1返回参数is_leaf增加返回值的描述 19巡航轨迹和预置位下的章节重新排序，并添加只支持好望设备说明 19.3响应参数preset_index描述修改 19.5添加获取云台控制权接口的链接 19.6响应示例修改 19.7响应参数cruise_type巡航轨迹类型增加枚举描述 19.8和19.10章节请求参数speedLevel描述修改 2023-02-02 第五十三次正式发布 本次变更如下： 11.1查询人流统计日周年信息关于MONTH枚举类型补充改正 11.2响应体描述补充 17.1增加仅支持好望设备/通道的提示 17.2增加仅支持好望设备/通道的提示 2023-01-13 第五十二次正式发布 本次变更如下： 8.3查询通道详情章节响应体中新增通道类型字段 2023-01-10 第五十一次正式发布 本次变更如下： DEVICE_ALARM 消息类型添加字段 alarm_attr 2023-01-04 第五十次正式发布 本次变更如下： auth_key 参数完善 告警智能图片下载兼容 THIRDPARTY_INTELLIGENT 三方告警类型 2023-01-04 第四十九次正式发布 本次变更如下： 20.5添加预置位章节增加直连场景的入参。 2023-01-03 第四十八次正式发布 本次变更如下： 批量添加目标图片功能，参数提示描述完善 2022-12-30 第四十七次正式发布 本次变更如下： 8.2 查询通道列表章节，增加返回channel_type字段。 原19.8章节后插入三个章节描述新版本目标库新增，修改，删除功能的接口。 2022-11-25 第四十六次正式发布 本次变更如下： 11.1 查询人流统计日月周年信息章节，type字段描述修改。 2022-11-25 第四十五次正式发布 本次变更如下： 修改API管理， 将调用的地址不隐藏，让文档更易懂。 2022-09-30 第四十四次正式发布 本次变更如下： 新增长尾算法接口 2022-08-08 第四十三次正式发布 本次变更如下： 配置用户 消息通知 URL 添加 HEAD_SHOULDER_DATA、BEHAVIOR_ANALYSIS_DATA、MICRO_CHECKPOINT_DATA 枚举值 2022-08-08 第四十二次正式发布 本次变更如下： 获取时间热度图统计中修改type枚举值分隔符 获取空间热度图统计中修改type枚举值分隔符 2022-07-20 第四十一次正式发布 本次变更如下： 新增设备云上能力集查询接口 设备、通道详情接口新增云上能力集查询相关字段 新增动检录像计划相关接口 2022-06-08 第四十次正式发布 本次变更如下： 查询通道的录像计划接口新增字段 2022-06-02 第三十九次正式发布 本次变更如下： 云台枚举值新增描述 2022-05-31 第三十八次正式发布 本次变更如下： HLS实况URL增加禁用音频选项 批量获取P2P回放URL接口中增加开始结束时间选项 2022-04-21 第三十七次正式发布 本次变更如下： 修改设备信息的入参返回值 云台点动接口参数补充 2022-04-19 第三十六次正式发布 本次变更如下： 修改目标库相关接口的入参返回值格式问题 2022-03-29 第三十五次正式发布 本次变更如下： 原先接口缺少的约束和字段补全 新增云台点动接口 新增设备目标授权配置接口 2022-03-25 第三十四次正式发布 本次变更如下： 添加空间热力图base64转RGB的伪代码说明 2022-03-14 第三十三次正式发布 本次变更如下： 接口api发布：新增目标库与修改目标库接口请求示例错误修正 2022-03-12 第三十二次正式发布 本次变更如下： 接口api发布：新增目标库，修改目标库，删除目标库 错误码新增：IVM.20000036 2022-03-02 第三十一次正式发布 本次变更如下： 目标库接口目标年龄用例String类型修改为Integer类型 云台转动填写新的档位，云台光圈聚焦增加一键聚焦功能和点动聚焦功能 目标库添加增加external_target_id 2022-02-23 第三十次正式发布 本次变更如下： 新增错误码：IVM.20090016 2022-02-18 第二十九次正式发布 本次变更如下： 新增支持wss协议播放接口 新增媒体播放管理部分接口支持url自定义超时时间和次数 修改云端录像record_type枚举值 2022-02-11 第二十八次正式发布 本次变更如下： 修正查询通道的前端录像回放地址(仅支持HLS协议)接口 2022-01-29 第二十七次正式发布 本次变更如下： 修改itgt_type 字段枚举值 2022-01-17 第二十六次正式发布 本次变更如下： 修改告警推送消息体结构的message_type为device_status时的请求示例 2022-01-12 第二十五次正式发布 本次变更如下： 批量获取设备实况播放地址删除仅支持国标设备描述 2021-12-27 第二十四次正式发布 本次变更如下： 周界检测告警参数配置和获取周界检测告警参数添加结构体 region 、point 2021-12-16 第二十三次正式发布 本次变更如下： 巡航轨迹和预置位功能重新上线 设备密码修改 查询设备码流能力和码流列表特性 2021-12-09 第二十二次正式发布 本次变更如下： 添加三种智能业务：头肩业务、行为分析与人车物分离、微卡口业务 target_data 目标及目标整体业务和 vehicle_data 机非人业务新增字段 2021-12-06 第二十一次正式发布 本次变更如下： 添加HLS协议实况、云端回放、前端回放地址 2021-11-25 第二十次正式发布 本次变更如下： 设备密码、码流远程配置、巡航轨迹和预置位接口删除 2021-11-24 第十九次正式发布 本次变更如下： 设备密码和码流远程配置接口添加 2021-11-23 第十八次正式发布 添加各种类型设备目标库字段支持情况 2021-11-05 第十七次正式发布 本次变更如下： 告警推送消息结构体的 target_data 类型新增五个字段： itgt_version String 目标识别算法版本号 quality_score Int 目标识别目标抠图质量分 target_url String 目标抠图的 URL target_all_pic_url String 目标整体抠图的 URL panorama_url String 目标全景的 URL 2021-11-01 第十七次正式发布 本次变更如下： 巡航轨迹和预置位接口添加 2021-08-27 第十六次正式发布 本次变更如下： 修改通道名称修改为只支持好望协议，通道名称修改特殊字符增加. 2021-08-19 第十五次正式发布 本次变更如下： OSD名称相关，名字增加对换行符的支持 2021-08-18 第十四次正式发布 本次变更如下： 添加设备升级失败的字段，及响应示例 2021-08-13 第十三次正式发布 本次变更如下： 添加查询用户URL的响应示例 2021-08-06 第十二次正式发布 本次变更如下： 修改配置周界告警参数配置的请求示例 给配置用户消息通知URL接口新增了接口说明 2021-07-23 第十一次正式发布 本次变更如下： 批量添加设备(仅支持GB28181协议)接口增加algorithm字段 添加目标库接口文档 发送云台聚焦和光圈控制命令params改为必填参数 2021-07-08 第十次正式发布 本次变更如下： 消息回调接口增加auth_key字段 2021-06-25 第九次正式发布 本次变更如下： 解决：消息推送ISV，回调URL接口，告警图片下载接口的MG信息问题 补充描述，智能及告警图片下载路径有效期五分钟 2021-06-11 第八次正式发布 本次变更如下： 告警推送新增物品遗留、移走、电瓶车等告警类型，图片下载接口新增第三方智能算法。 新增告警参数配置（两个接口） 2021-05-14 第七次正式发布 本次变更如下： 新增云端抓拍目录，新增云端抓拍设备接口 2021-04-28 第六次正式发布 本次变更如下： 部分接口增加详细说明，比如设备实况地址获取接口仅支持国标 2021-04-15 第五次正式发布 本次变更如下： 下线FLV、WASM等内容。 2021-04-12 第四次正式发布 本次变更如下： 告警推送消息体结构，修改 rect 对象的字段名 2021-04-06 第三次正式发布 本次变更如下： API参考中增加“附录”目录，附录中存放状态码、错误码以及其他北向接口调用参考信息； 告警消息结构体从“用户指南”移动到了“消息管理”目录中。 LiveWebURLDto参数对象中的“stream_type”码流参数类型补充了取值范围。 增加了“使用前必读”、“API概览”、“如何调用API”说明目录。 2021-03-05 第二次正式发布 本次变更如下： API目录名称统一去除“北向”两字。 新增“智能图片下载”、“告警图片下载”北向接口目录及所属能力接口。 2020-12-15 第一次正式发布

URI GET /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章节

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 channel_name 是 String 通道名称：支持英文、中文（一个汉字算两个字符）、数字、特殊字符（_-.空格换行符），长度范围[1,128]

URI PUT /v1/{user_id}/devices/{device_id}/channels/{channel_id} 表1 路径参数 参数 是否必选 参数类型 描述 channel_id 是 String 通道ID： 好望设备：取值范围[0,999] device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 、 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节

URI GET /v1/{user_id}/device-orgs/{device_org_id}/sub-orgs 表1 路径参数 参数 是否必选 参数类型 描述 device_org_id 是 String 设备组织ID：由数字组成，长度范围[1,25]（根组织节点的值为0，从此接口逐级往下获取子组织节点） user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 orgs Array of getChildOrgResp_org_list objects 响应信息 表4 getChildOrgResp_org_list 参数 参数类型 描述 device_org_id String 设备组织ID device_org_name String 设备组织名称 device_org_level Integer 设备组织级别，第一级子节点数值为1，第二级为2，以此类推 camera_count Integer 该设备组织下的（包括子级组织）设备个数 camera_online_count Integer 该设备组织下的（包括子级组织）设备在线数量 is_leaf Integer 是否是叶子节点：枚举类型 枚举值： 1 叶子节点，没有子级设备组织 0 非叶子节点，有子级设备组织 channel_count Integer 该设备组织下的（包括子级组织）通道在线数量 channel_online_count Integer 该设备组织下的（包括子级组织）通道在线总数 channel_offline_count Integer 该设备组织下的（包括子级组织）通道离线总数

响应示例 状态码： 200 OK { "orgs" : [ { "device_org_id" : "1234567890***", "device_org_name" : "3级分组", "device_org_level" : 3, "camera_count" : 10, "camera_online_count" : 5, "is_leaf" : 0, "channel_count" : 200, "channel_online_count" : 50, "channel_offline_count" : 150 } ] }

查询设备码流能力和码流列表 接口 说明 GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/stream-ability 查询设备码流能力和码流列表 GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/stream-detail 查询设备码流详情，目前仅支持好望设备 POST /v1/{user_id}/devices/{device_id}/channels/{channel_id}/stream-detail 设备码流配置

设备密码修改 接口 说明 GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/security-key 查询设备密码状态，仅支持好望SDC直连设备 PUT /v1/{user_id}/devices/{device_id}/channels/{channel_id}/security-key 设置或修改设备密码，仅支持好望SDC直连设备

设备目标授权配置 接口 说明 PUT /v1/{user_id}/devices/{device_id}/channels/targets/authorization 批量设置通道目标授权状态，只支持好望设备 GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/targets/authorization 查询设备目标授权状态，仅支持好望设备

目标库 接口 说明 POST /v1/{user_id}/target/batch-delete 删除目标信息 PUT /v1/{user_id}/targets 批量修改目标信息 POST /v1/{user_id}/targets/batch-add 目标批量添加 GET /v1/{user_id}/targets/ids 按索引范围获取目标ID列表 GET /v1/{user_id}/target-groups 获取目标库分组 POST /v1/{user_id}/target-groups 新增目标库分组 PUT /v1/{user_id}/target-groups 修改目标库分组 DELETE /v1/{user_id}/target-groups 删除目标库分组 POST /v2/{user_id}/target-groups 新增目标库分组v2 PUT /v2/{user_id}/target-groups 修改目标库分组v2 DELETE /v2/{user_id}/target-groups 删除目标库分组v2 GET /v1/{user_id}/targets 按索引范围获取目标信息列表 POST /v1/{user_id}/targets 获取目标信息（IVS1800不支持） GET /v1/{user_id}/targets/count 获取目标库分组中的目标数量