华为云用户手册

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

URI POST /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参数 参数 是否必选 参数类型 描述 preset_name 是 String 预置位名称：数字、中文、英文、空格、-、_，.，长度范围[1,128] index 否 Integer 预置位序号：直连设备必传，非直连场景不传。取值范围[1,512]

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

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

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 group_id Integer 目标库分组ID：目标库标识符 target_ids Array of TargetResultVo objects 目标ID列表 表5 TargetResultVo 参数 参数类型 描述 target_id String 目标ID：目标标识符 result Result object 结果码 表6 Result 参数 参数类型 描述 code String 错误编码 msg String 错误信息

请求示例 批量修改目标信息 PUT /v1/2562572829***/targets { "device_id":"952352LWXT***", "group_id":2, "targets":[ { "target_id":"2", "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..."}] }

响应示例 状态码： 200 OK { "group_id" : 2, "target_ids" : [ { "result" : { "code" : "IVM.0", "msg" : "Success" }, "target_id" : "2", "external_target_id" : "1234567890123456" } ] }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 group_id Integer 目标库分组ID：目标库标识符 target_ids Array of TargetResultVo objects 目标ID列表 表6 TargetResultVo 参数 参数类型 描述 target_id String 目标ID：目标标识符 result Result object 结果信息 external_target_id String 用户传入的目标ID：用户自定义的，在添加目标的时候由客户填入 表7 Result 参数 参数类型 描述 code String 错误编码 msg String 错误信息

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 group_id 是 Integer 目标库分组ID：非负值，从获取目标库分组接口获取 targets 是 TargetDto object 目标数据列表： NVR800和IVS1800：9.1以上版本支持该接口，支持批量修改，最多支持修改20个目标，NVR800的所有图片合计最大为700K，NVR800在脱敏库中目标无法进行修改 SDC：仅支持单目标修改 storage 否 Boolean 是否保存图片：false-不保存图片，true-保存图片，默认值true，NVR800的不保存图片就会保存到脱敏名单库中，SDC和NVR800修改时改字段不生效 表4 TargetDto 参数 是否必选 参数类型 描述 target_id 是 String 目标ID：支持数字和-，长度范围[1,20]，需要已添加目标才可以修改，可以从按索引范围获取目标ID列表、获取目标信息、按索引范围获取目标ID信息中获取 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支持） remark 否 String 备注信息：支持大小写字母数字，长度范围[1,512]（SDC不支持） jpegBase64 是 String 目标图片：经过base64编码（单个图片建议不超过50K），支持png、jpeg、jpg格式 domicile 否 String 居住地：支持大小写字母数字，长度范围[1,256]（IVS1800不支持）

请求示例 批量添加目标 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 表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 错误信息

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

URI GET /v1/{user_id}/targets/ids 表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 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 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 group_id 是 Integer 目标库分组ID：非负值，从获取目标库分组接口获取 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 group_id 是 Integer 目标库分组ID：非负值，从获取目标库分组接口获取 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取

请求参数 表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 失效

请求参数 表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 失效

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 group_name 是 String 目标库分组名称：最大为63位 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 group_type 否 String 目标库分组类型：枚举类型，不同设备支持的枚举类型不一样 NVR800设备下的目标库分组类型：不填默认为白名单 枚举值： WHITE 白名单 STRANGE 陌生人 BLACK 黑名单 SDC设备下的目标库分组类型：不填默认为其他名单 枚举值： OTHER 其他名单 DEFAULT 默认名单 WHITE 白名单 IVS1800设备下的目标库分组类型：不填默认为白名单 枚举值： WHITE 白名单 STRANGE 陌生人 RED 红名单

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 group_name 是 String 目标库分组名称：最大为63位 device_id 是 String 设备ID： 好望设备：大小写字母、数字组成，长度范围[8,32]，可在设备外壳或者设备web页面上获取 group_type 否 String 目标库分组类型：枚举类型，不同设备支持的枚举类型不一样 NVR800设备下的目标库分组类型：不填默认为白名单 枚举值： WHITE 白名单 STRANGE 陌生人 BLACK 黑名单 SDC设备下的目标库分组类型：不填默认为其他名单 枚举值： OTHER 其他名单 DEFAULT 默认名单 WHITE 白名单 IVS1800设备下的目标库分组类型：不填默认为白名单 枚举值： WHITE 白名单 STRANGE 陌生人 RED 红名单

响应示例 状态码： 200 OK { "groups": [ { "name": "ssre2d", "enable": "CLOSE", "group_id": 2, "is_fixed": true, "is_hidden": false } ], "device_id": "952352LWXT***", "group_max_count": 128 }

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页面上获取

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 device_id String 设备id channel_id String 通道id resources Array of ChannelResource objects 响应信息 表4 ChannelResource 参数 参数类型 描述 resource_id String 资源id resource_name String 资源名称 resource_type_code String 资源类型编码 MANAGE 视图接入调阅 NORMAL 连续 云存储 DATAFLOW 行业数据流 MOTION 动检云存储 resource_state String 资源状态 NORMAL 正常 ARREARS 欠费 UNAVAILABLE 不可使用冻结

响应示例 状态码： 200 OK { "device_id" : "5648781*****", "channel_id" : "666", "resources" : [ { "resource_id" : "c0d3c9f9b70b4c3599fe4a98eb2a****", "resource_name" : "90天动检检云存储月套餐", "resource_type_code" : "MOTION", "resource_state" : "NORMAL" }, { "resource_id" : "c0d3c9f9b70b4c3599fe4a98eb2a****", "resource_name" : "设备按需动检收录套餐", "resource_type_code" : "MOTION", "resource_state" : "NORMAL" } ] }