文档首页/ 行业视频管理服务 IVM/ API参考/ 目标库接口/ 获取目标库分组
更新时间：2024-05-21 GMT+08:00
查看PDF
分享

获取目标库分组

功能介绍

获取目标库分组，仅支持好望协议设备，使用该接口需要设备安装了目标算法，NVR800需要切换到人卡模式，SDC直连需要开启目标库对比

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

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

Access-Token

是

String

用户认证AccessToken：从获取用户北向接口认证AccessToken中获取

响应参数

状态码： 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

请求示例

获取直连SDC的目标库分组

GET /v1/2562572829***/target-groups?device_id=952352LWXT***

响应示例

状态码： 200

OK

{
    "groups": [
       {
          "name": "ssre2d",
          "enable": "CLOSE",
          "group_id": 2,
          "is_fixed": true,
          "is_hidden": false
       }
    ],
    "device_id": "952352LWXT***",
    "group_max_count": 128
}

状态码

请参见状态码

错误码

请参见错误码

父主题： 目标库接口

相关文档