华为云用户手册

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 callback_url String 支持http/https协议，最大长度为256英文字符 create_time String 创建时间 update_time String 更新时间 subscription_type String 订阅类型字段， 枚举值： DEVICE_ALARM 智能告警消息（含第三方告警），该消息的数据推送结构体设备智能告警消息结构体 DEVICE_EXCEPTION 设备异常消息，该消息的数据推送结构体设备异常告警消息结构体 DEVICE_UNBIND 设备解绑、套餐解绑数据，该消息的数据推送结构体设备解绑消息结构体 TARGET_DATA 目标TLV数据，该消息的数据推送结构体目标数据消息结构体 THIRD_DATA 第三方TLV数据，该消息的数据推送结构体三方数据消息结构体 VEHICLE_DATA 机非人TLV数据，该消息的数据推送结构体机非人消息结构体 HEAD_SHOULDER_DATA 头肩业务TLV数据，该消息的数据推送结构体头肩业务消息结构体 BEHAVIOR_ANALYSIS_DATA 行为分析TLV数据，该消息的数据推送结构体行为分析与人车物分离消息结构体 MICRO_CHECKPOINT_DATA 微卡口TLV数据，该消息的数据推送结构体微卡口数据推送结构体 auth_key String 鉴权密钥

响应示例 当URL存在时： { "callback_url": "http://xxxxxx:xx", "subscription_type": "DEVICE_ALARM", "create_time": "2021-03-30 14:34:50", "update_time": "2021-03-30 15:34:50", "auth_key": "xxxxxxx" } 当URL不存在时： {}

URI GET /v1/{user_id}/messages/callback 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户ID：由数字组成，长度范围[15,25]，获取方式参考获取user ID与下载AK/SK章节 表2 Query参数 参数 是否必选 参数类型 描述 subscription_type 是 String 订阅类型字段 枚举值： DEVICE_ALARM 智能告警消息（含第三方告警），该消息的数据推送结构体设备智能告警消息结构体 DEVICE_EXCEPTION 设备异常消息，该消息的数据推送结构体设备异常告警消息结构体 DEVICE_UNBIND 设备解绑、套餐解绑数据，该消息的数据推送结构体设备解绑消息结构体 TARGET_DATA 目标TLV数据，该消息的数据推送结构体目标数据消息结构体 THIRD_DATA 第三方TLV数据，该消息的数据推送结构体三方数据消息结构体 VEHICLE_DATA 机非人TLV数据，该消息的数据推送结构体机非人消息结构体 HEAD_SHOULDER_DATA 头肩业务TLV数据，该消息的数据推送结构体头肩业务消息结构体 BEHAVIOR_ANALYSIS_DATA 行为分析TLV数据，该消息的数据推送结构体行为分析与人车物分离消息结构体 MICRO_CHECKPOINT_DATA 微卡口TLV数据，该消息的数据推送结构体微卡口数据推送结构体

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

响应示例 状态码： 200 OK { "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" : "1234567890123456" }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 target_ids 是 Array of strings 目标ID列表：数组长度范围[1,100] 目标ID：支持数字和-，长度范围[1,20]，SDC的目标ID需要带上目标库ID（目标库ID_目标ID的形式）， 可以从按索引范围获取目标ID列表、获取目标信息、按索引范围获取目标ID信息中获取

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 targets Array of TargetVo objects 目标列表（SDC仅返回图片信息和用户传入的目标ID） 表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：用户自定义的，在添加目标的时候由客户填入

请求参数 表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 表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 错误码描述

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

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 failed_num Integer 失败数量 devices Array of BatchAddGBDevicesRespItem objects 添加结果详细信息 表6 BatchAddGBDevicesRespItem 参数 参数类型 描述 device_id String 设备ID，设备唯一标识符 sip_server_id String SIP服务器ID sip_server_domain String SIP服务器域 sip_server_host String SIP服务器地址 sip_server_port String SIP服务器端口 result Result object 错误或成功信息 表7 Result 参数 参数类型 描述 code String 错误编码 msg String 错误信息

响应示例 状态码： 200 OK { "failed_num" : 0, "devices" : [ { "device_id" : "952352LWXT***", "sip_server_id" : "3402000000***", "sip_server_domain" : "3402***", "sip_server_host" : "123.123.*.*", "sip_server_port" : "5060", "result" : { "code" : "IVM.0", "msg" : "Success" } } ] }

请求示例 添加国标协议设备 POST /v1/2562572829***/devices/gb/batch-add { "devices" : [ { "device_id" : "952352LWXT***", "device_name": "DEVICE01", "device_username" : "admin", "device_password" : "***", "algorithm": "MD5" } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 preset_positions Array of getPresetPositionItem objects 预置位信息列表 表4 getPresetPositionItem 参数 参数类型 描述 preset_index Integer 预置点位序号 preset_name String 预置点位名称 jpg_base64 String jpg图片，jpg格式的图片经过base64编码后的字符串

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 device_name 否 String 设备名称：字符组成，支持数字、中文（一个汉字算两个字符）、英文大小写、空格、-、_，长度范围[1,128] description 否 String 设备描述：字符组成，支持数字、中文（一个汉字算两个字符）、英文大小写、空格、-、_，长度范围[1,128] modify_type 否 String 修改类型：枚举类型，默认值DEFAULT。 好望设备不检测该参数 枚举值： DEFAULT 国标协议接入设备按参数device_name修改设备名称和osd，仅设备在线可修改。此时需要device_name字段有值 OSD 设备osd修改，仅支持国标协议接入的设备，仅设备在线可修改。此时需要参数osd字段有值 DEVICE_NAME 设备名称修改，仅支持国标协议接入的设备，无论设备什么状态均可修改。此时需要参数device_name字段有值 ALL 分别按device_name和osd修改，仅支持国标协议接入的设备，仅设备在线可修改。此时参数osd、参数device_name字段均需有值 osd 否 String osd内容：长度范围[1,63]，一个中文占3个字节 说明： 在modify_type为DEFAULT或者DEVICE_NAME时忽略此参数。

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 device_id String 设备ID，设备唯一标识 channel_id String 通道ID channel_name String 通道名称 channel_state String 通道状态 枚举值： OFFLINE 离线 ONLINE 在线 UNREGISTERED 未注册 access_protocol String 接入协议 枚举值： HOLO 好望协议 GB28181 国标协议 channel_system_state String 设备系统状态 枚举值： NORMAL 正常 UNAVAILABLE_FROZEN 冻结 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_ability String 通道能力集：枚举类型，参考附录设备能力集，多个能力集用逗号分隔 device_cloud_ability Object 云端能力集规格 model String 通道的设备型号，如：D3250 channel_intelligent String 智能算法能力集 firmware String 通道的设备固件版本号，如：SDC 10.0.0 create_time String 通道创建时间 update_time String 通道更新时间 sn String SN号 channel_firmware_id String 通道的设备固件版本号 channel_type String 通道类型 resolution String 分辨率

响应示例 状态码： 200 OK { "device_id" : "952352DJNR***", "channel_id" : "0", "channel_name" : "龙岗通道1", "channel_state" : "ONLINE", "access_protocol" : "HOLO", "channel_system_state" : "NORMAL", "channel_resource_state" : [ "MANAGEMENT_GRANT", "EVENT_RECORD_CLOSED", "FULL_RECORD_CLOSED" ], "channel_ability" : "ptz,talk", "device_cloud_ability": { "alarm_voice": { "support": "true" }}, "model" : "L", "channel_intelligent" : "[{\"name\":\"perimeter\",\"enable\":true}]", "firmware" : "V22", "channel_firmware_id": "", "create_time" : "2020-06-26 20:42:16.0", "update_time": "2023-12-05 10:09:46.0", "sn": "", "channel_type": "IPC", "resolution": "5/6/4" }

URI GET /v1/{user_id}/devices/{device_id}/channels/{channel_id} 表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 Query参数 参数 是否必选 参数类型 描述 ability 否 Array of strings 查询的能力集列表：不传默认查询所有能力集，数组长度范围[0,10] need_cloud_ability 否 Boolean 是否需要返回云上管理的能力集：false，不返回云上能力集信息；true，返回云上能力集信息。不填默认false need_specification 否 Boolean 是否需要能力规格：false，不返回能力规格；true，返回能力规格。不填默认false 表3 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取

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

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 该设备组织下的（包括子级组织）通道离线总数

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]