1. 安防人脸布控

安防人脸布控


1.1. 批量添加

基础信息

路径: /v1/api/pass/rule/addBatch

请求方法: POST

备注: 进行安防人脸模块布控,可进行实名人员或未知人员布控,可选择指定的时间计划、分析源。此操作较为耗时,选择分析源越多耗时越久,请合理选择分析源数量。

请求参数

Headers:

名称 必须 备注
Content-Type application/json

Body:

名称 类型 必须 默认值 备注
ruleList object[] 规则实体列表
|─pointUuids string[] 分析源:选填,支持多选-只展示符合算力资源要求的监控点供用户选择,例如选择了算力资源为边端算力,分析源只展示B4H和C4H-240上报的监控点 * 规则类型为未知人员时分析源也可以选择面板机上报的门禁点;离线文件分析可为空
|─analysisSourceType integer 分析源类型,离线分析时必填:1-监控点;2-视频文件
|─computerUnit integer 算力单元 1中心算力 2边端算力
|─personRange integer 布控人员范围 1.实名人员 2.未知人员(与typeList相同含义,如两者同时传递personRange优先级高)
|─speed integer 倍速设置,离线分析时必填(通过《微服务模块》《获取视频文件播放时长》接口获取视频时长)
|─videoUri string 视频文件uri
|─typeList integer[] 类型:1 关注人员,2 全局陌生人,3 基础人员,4 访客(兼容字段,新版本对接建议使用personRange)
|─videoName string 视频文件名称
|─scheduleUUId string 时间计划uuid,离线布控时为空
|─ruleType integer 任务类型 1.实时分析 2.离线分析 默认1
|─name string 规则名称
|─reportUnauthorizedFlag boolean 是否上报未授权人员
|─startTime integer 离线分析开始时间,单位:毫秒。如果是视频文件,则为当前时间戳+视频的开始时间,比如视频时长为5s,想要分析第1s到第4s的内容,startTime=当前时间+1*1000
|─endTime integer 离线分析结束时间,单位:毫秒。如果是视频文件,则为当前时间戳+视频的结束时间,比如视频时长为5s,想要分析第1s到第4s的内容,endTime=当前时间+4*1000
|─groupUUidList string[] 选择人员组,基础人员、访客、关注人员必填,未知人员无需传递

Body示例:

1.实时布控-中心
{
    "ruleList": [
        {
            "ruleName": "实时布控-中心",
            "ruleType": 1,
            "personRange": 1,
            "computerUnit": 1,
            "analysisSourceType": 1,
            "pointUuids": [
                "f908e506da2f47b28c93a4d7536d1196"
            ],
            "groupUuids": [
                "5dc196fa903a42a386f0e0ee8ba23fc0",
                "dd2faa47b3c842139ca3f41fb922a6e2"
            ],
            "scheduleUuid": "851b75f2d16b40a18b17e281b1f73333",
            "reportUnauthorizedFlag": 1
        }
    ]
}
2.实时-未知-边缘布控
{
    "ruleList": [
         {
            "ruleName": "实时-未知-边缘布控",
            "ruleType": 1,
            "personRange": 1,
            "computerUnit": 2,
            "analysisSourceType": 1,
            "pointUuids": [
                "f4581bb3aa384d7cb7a870b8672e4114"
            ],
            "groupUuids": [
                "5dc196fa903a42a386f0e0ee8ba23fc0",
                "dd2faa47b3c842139ca3f41fb922a6e2"
            ],
            "scheduleUuid": "851b75f2d16b40a18b17e281b1f73333",
            "reportUnauthorizedFlag": 1
         }
    ]
}
3.离线分析-实名-监控点布控
{
    "ruleList": [
        {
            "ruleName": "离线分析-实名-监控点布控",
            "ruleType": 2,
            "personRange": 1,
            "computerUnit": 1,
            "analysisSourceType": 1,
            "pointUuids": [
                "cfa8c01aa14745928295316380b04da3"
            ],
            "groupUuids": [
                "5dc196fa903a42a386f0e0ee8ba23fc0",
                "dd2faa47b3c842139ca3f41fb922a6e2"
            ],
            "reportUnauthorizedFlag": 1,
            "speed": 2,
            "startTime": 1700603234000,
            "endTime": 1700646441263
        }
    ]
}
4.离线分析-未知-视频文件布控,pointUuids可以不选,选且仅能选一个
{
    "ruleList": [
        {
            "ruleName": "离线分析-未知-视频文件布控",
            "ruleType": 2,
            "personRange": 2,
            "computerUnit": 1,
            "analysisSourceType": 2,
            "pointUuids": [
                "7da42248a10a407b9776c79c6be136b6" 
            ],
            "speed": 2,
            "startTime": 1700646574374,
            "endTime": 1700646606574,
            "videoUri": "Z3NwOi8vd3Vrb25n-0d6d68144df2d6c_22174934_570.mp4",
            "videoName": "koala_C2_26ren.mp4"
        }
    ]
}

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8

Body:

名称 类型 必须 默认值 备注
code integer 状态码
msg string 状态描述
data object 具体的返回值
|─failures object[] 失败列表
  |─msg string 结果信息提示
  |─msgs string[] 记录多点位布控情况下部分失败的点位,为空表示全部成功
  |─code integer 结果状态码
  |─typeList integer[] 类型:1 关注人员,2 全局陌生人,3 基础人员,4 访客
  |─pointUuids string[] 分析源-监控点
  |─scheduleUUId string 时间计划uuid
  |─name string 规则名称
  |─reportUnauthorizedFlag boolean 是否上报未授权人员
  |─personRange integer 布控人员范围 1.实名人员 2.未知人员(与typeList相同含义,建议使用此字段)
  |─uuid string 布控Uuid
  |─groupUUidList string[] 选择人员组,基础人员、访客、关注人员必填,未知人员无需传递
|─successes object[] 成功列表
  |─msg string 结果信息提示
  |─msgs string[] 记录多点位布控情况下部分失败的点位,为空表示全部成功
  |─code integer 结果状态码
  |─typeList integer[] 类型:1 关注人员,2 全局陌生人,3 基础人员,4 访客
  |─pointUuids string[] 分析源-监控点
  |─scheduleUUId string 时间计划uuid
  |─name string 规则名称
  |─reportUnauthorizedFlag boolean 是否上报未授权人员
  |─personRange integer 布控人员范围 1.实名人员 2.未知人员(与typeList相同含义,建议使用此字段)
  |─uuid string 布控Uuid
  |─groupUUidList string[] 选择人员组,基础人员、访客、关注人员必填,未知人员无需传递

响应示例:

{
    "code":0,
    "data":{
        "failures":[],
        "successes":[
            {
                "groupUUidList":[
                    "d46893e0ad5546399e5c015b474e29ef"
                ],
                "msgs":[],
                "name":"OPenAPi通道1实名人员布控",
                "pointUuids":[
                    "1984c42edda94dfb90be95dd34eef82e"
                ],
                "reportUnauthorizedFlag":true,
                "scheduleUUId":"851b75f2d16b40a18b17e281b1f73333",
                "typeList":[
                    1,
                    3,
                    4
                ],
                "uuid":"924d2940bc0e4339946f40baca19eb67"
            }
        ]
    },
    "msg":"成功"
}

1.2. 批量删除

基础信息

路径: /v1/api/pass/rule/deleteBatch

请求方法: POST

备注: 根据规则ID集合批量删除安防布控

请求参数

Headers:

名称 必须 备注
Content-Type application/json

Body:

名称 类型 必须 默认值 备注
ruleIdList array 规则uuid列表
  |─ string

Body示例:

{
  "ruleIdList": [
    "924d2940bc0e4339946f40baca19eb67"
  ]
}

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值
  |─successes array 成功列表
    |─ object
      |─uuid string uuid
      |─code integer 结果状态码
      |─msg string 结果信息提示
  |─failures array 失败列表
    |─ object
      |─uuid string uuid
      |─code integer 结果状态码
      |─msg string 结果信息提示

响应示例:

{
    "code":0,
    "data":{
        "failures":[],
        "successes":[
            {
                "uuid":"924d2940bc0e4339946f40baca19eb67"
            }
        ]
    },
    "msg":"成功"
}

1.3. 更新规则

基础信息

路径: /v1/api/pass/rule/update

请求方法: POST

备注: 更新安防布控信息,不支持更换布控类型,允许修改布控名称、分析源、组、时间计划信息,修改分析源信息时操作耗时相对较长

请求参数

Headers:

名称 必须 备注
Content-Type application/json

Body:

名称 类型 必须 默认值 备注
ruleType integer 任务类型 1.实时分析 2.离线分析 默认1 不能修改但是需要传
typeList integer[] 类型:1 关注人员,2 全局陌生人,3 基础人员,4 访客(兼容字段,新版本对接建议使用personRange)
pointUuids string[] 分析源-监控点
scheduleUUId string 时间计划uuid,离线布控时为空
name string 规则名称
reportUnauthorizedFlag boolean **否 是否上报未授权人员(typeList包含2或personRange=2时此值配置不生效)
personRange integer 布控人员范围 1.实名人员 2.未知人员(与typeList相同含义,如两者同时传递personRange优先级高)
groupList string[] 选择人员组,基础人员、访客、关注人员必填,未知人员无需传递
uuid string uuid
computerUnit integer 算力单元 1中心算力 2边端算力

Body示例:

{
    "uuid": "924d2940bc0e4339946f40baca19eb67",
    "name": "OPenAPi通道1实名人员布控修改",
    "ruleType":1,
    "computerUnit":1,
    "personRange": 1,
    "scheduleUUId": "851b75f2d16b40a18b17e281b1f73333",
    "reportUnauthorizedFlag": true,
    "pointUuids": [
        "1984c42edda94dfb90be95dd34eef82e",
        "8d4da39c937e47a587ab1af6c8d7a501"
    ],
    "groupList": [
        "d46893e0ad5546399e5c015b474e29ef"
    ]
}

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data object 具体的返回值
  |─uuid string 布控Uuid
  |─msg array 记录多点位布控情况下部分失败的点位,为空表示全部成功
    |─ string

响应示例:

{
    "code":0,
    "data":{
        "msg":[],
        "uuid":"924d2940bc0e4339946f40baca19eb67"
    },
    "msg":"成功"
}

1.4. 分页查询

基础信息

路径: /v1/api/pass/rule/list

请求方法: POST

备注: 分页查询安防布控列表

请求参数

Headers:

名称 必须 备注
Content-Type application/json

Body:

名称 类型 必须 默认值 备注
name string 规则名称(输入,模糊检索)
personRange array 人员范围 1.实名人员 2.未知人员(选择,支持多选)
  |─ integer
pointUuids array 分析源 (支持多选)
  |─ string
groupUuids array 人员组(支持多选)
  |─ string
pageNum integer 1 当前页码,不传默认1
pageSize integer 10 分页大小,不传默认10

Body示例:

{
  "pageNum": 1,
  "pageSize": 10
}

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8

Body:

名称 类型 必须 默认值 备注
code integer 状态码
msg string 状态描述
data object 具体的返回值
|─total integer 总数
|─pageSize integer 分页大小
|─list object[] list
  |─groups object[] 人员组
    |─name string 组名称
    |─uuid string 组Uuid
  |─computerUnit integer 算力单元 1.中心算力 2.边端算力
  |─personRange integer 布控人员范围 1.实名人员 2.未知人员 默认1
  |─uuid string 布控Uuid
  |─points object[] 分析源-监控点
    |─name string 监控点位名称
    |─uuid string 监控点位Uuid
  |─schedule object schedule
    |─name string 时间计划名称
    |─uuid string 时间计划uuid
  |─enable integer 启用状态,0:关闭,1:启用
  |─ruleType integer 任务类型 1.实时分析 2.离线分析 默认1
  |─scheduleUUId string 时间计划uuid
  |─name string 规则名称
  |─estimate integer 离线布控预估耗时
  |─reportUnauthorizedFlag boolean 是否上报未授权人员
  |─status integer 状态(2:进行中、4:已完成、5:异常)
|─pageNum integer 当前页码

响应示例:

{
    "code":0,
    "data":{
        "list":[
            {
                "groups":[
                    {
                        "name":"测试权限",
                        "uuid":"d46893e0ad5546399e5c015b474e29ef"
                    }
                ],
                "ruleType":1,
                "personRange":1,
                "points":[
                    {
                        "name":"算力引擎1-通道2",
                        "uuid":"1984c42edda94dfb90be95dd34eef82e"
                    },
                    {
                        "name":"算力引擎1-通道4",
                        "uuid":"8d4da39c937e47a587ab1af6c8d7a501"
                    }
                ],
                "schedule":{
                    "name":"人车管控默认时间计划",
                    "uuid":"851b75f2d16b40a18b17e281b1f73333"
                },
                "uuid":"924d2940bc0e4339946f40baca19eb67"
            },
            {
                "groups":[],
                "personRange":2,
                "points":[
                    {
                        "name":"算力引擎1-通道17",
                        "uuid":"c132cdbb8b1a46a6aecf783b64719333"
                    }
                ],
                "schedule":{
                    "name":"人车管控默认时间计划",
                    "uuid":"851b75f2d16b40a18b17e281b1f73333"
                },
                "uuid":"aba9273dd23f4979ba2ca9fea388c64c"
            },
            {
                "groups":[
                    {
                        "name":"测试权限",
                        "uuid":"d46893e0ad5546399e5c015b474e29ef"
                    }
                ],
                "personRange":1,
                "points":[
                    {
                        "name":"hw的B4H-通道1",
                        "uuid":"176d34177858404387efb3940dae9c97"
                    }
                ],
                "schedule":{
                    "name":"人车管控默认时间计划",
                    "uuid":"851b75f2d16b40a18b17e281b1f73333"
                },
                "uuid":"dfb8a7a083b84a7a9bd61b0e4f06d1f1"
            }
        ],
        "pageNum":1,
        "pageSize":10,
        "total":3
    },
    "msg":"成功"
}

1.5. 查询详情

基础信息

路径: /v1/api/pass/rule/detail

请求方法: POST

备注: 根据布控规则ID查询安防布控详情

请求参数

Headers:

名称 必须 备注
Content-Type application/json

Body:

名称 类型 必须 默认值 备注
uuid string 布控UUID

Body示例:

{
  "uuid": "aba9273dd23f4979ba2ca9fea388c64c"
}

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8

Body:

名称 类型 必须 默认值 备注
code integer 状态码
msg string 状态描述
data object 具体的返回值
|─analysisSourceType integer 分析源类型,离线分析时必填
|─computerUnit integer 算力单元 1中心算力 2边端算力
|─groups object[] 人员组
  |─name string 组名称
  |─uuid string 组Uuid
|─personRange integer 布控人员范围 1.实名人员 2.未知人员 默认1
|─uuid string 规则UUID
|─speed integer 倍速
|─points object[] 分析源-监控点
  |─name string 监控点位名称
  |─uuid string 监控点位Uuid
|─videoUri string 视频文件uri
|─scheduleDTO object scheduleDTO
  |─name string 时间计划名称
  |─uuid string 时间计划uuid
|─videoName string 视频文件名字
|─ruleType integer 分析类型 1.实时分析 2.离线分析 默认1
|─ruleName string 规则名称
|─reportUnauthorizedFlag boolean 是否上报未授权人员
|─startTime integer 离线任务开始时间
|─endTime integer 离线任务结束时间
|─status integer 状态(2:进行中、4:已完成、5:异常),用于离线分析使用

响应示例:

{
    "code":0,
    "data":{
        "groups":[],
        "ruleType":1,
        "personRange":2,
        "points":[
            {
                "name":"算力引擎1-通道17",
                "uuid":"c132cdbb8b1a46a6aecf783b64719333"
            }
        ],
        "reportUnauthorizedFlag":false,
        "ruleName":"未知人员抓拍",
        "scheduleDTO":{
            "name":"人车管控默认时间计划",
            "uuid":"851b75f2d16b40a18b17e281b1f73333"
        },
        "uuid":"aba9273dd23f4979ba2ca9fea388c64c"
    },
    "msg":"成功"
}

1.6. 分析源点位列表

基础信息

路径: /v1/api/pass/rule/pointQuery

请求方法: POST

备注: 获取可布控安防(实名/未知)的点位列表

请求参数

Headers:

名称 必须 备注
Content-Type application/json

Body:

名称 类型 必须 默认值 备注
pointName string 点位名称(支持模糊查)

Body示例:

{
  "pointName": ""
}

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data array 具体的返回值
  |─ object
    |─pointUuid string 点位UUID
    |─pointName string 点位UUID
    |─pointType integer 点位类型 1.门禁点 2.监控点

响应示例:

{
    "code":0,
    "data":[
        {
            "pointName":"MegEye-W5K-I8",
            "pointType":1,
            "pointUuid":"b28a303784fd4dc7b3c73ad5794719f1"
        },
        {
            "pointName":"MegEye-W5K-I8",
            "pointType":1,
            "pointUuid":"164556f7761a43f683fe61f0ff4b659f"
        },
        {
            "pointName":"MegEye-W5K-I8-wbl",
            "pointType":1,
            "pointUuid":"814f1944880b40ac9128f69f251be133"
        },
        {
            "pointName":"MegEye-W4K-E7",
            "pointType":1,
            "pointUuid":"e846ac74465a4502b19b71f4d7093231"
        },
        {
            "pointName":"LZX-门禁点",
            "pointType":1,
            "pointUuid":"e8492a4060f54614bf57c77f4779df4f"
        },
        {
            "pointName":"千万别动MegEye-W5K-I8",
            "pointType":1,
            "pointUuid":"2c6c45a79e5449b58228b2d51b33e7ab"
        },
        {
            "pointName":"MegEye-W4K-E7",
            "pointType":1,
            "pointUuid":"69ee2490dd854eb9b28313aeaac7c4bd"
        },
        {
            "pointName":"算力引擎1-通道1",
            "pointType":2,
            "pointUuid":"f46159aef1ef45fba77ed1a644616d29"
        },
        {
            "pointName":"算力引擎1-通道4",
            "pointType":2,
            "pointUuid":"8d4da39c937e47a587ab1af6c8d7a501"
        },
        {
            "pointName":"算力引擎1-通道3",
            "pointType":2,
            "pointUuid":"407fe29b299b400e8fd95a013e78ce18"
        },
        {
            "pointName":"hw的B4H-通道1",
            "pointType":2,
            "pointUuid":"176d34177858404387efb3940dae9c97"
        },
        {
            "pointName":"算力引擎1-通道2",
            "pointType":2,
            "pointUuid":"1984c42edda94dfb90be95dd34eef82e"
        },
        {
            "pointName":"算力引擎1-通道17",
            "pointType":2,
            "pointUuid":"c132cdbb8b1a46a6aecf783b64719333"
        }
    ],
    "msg":"成功"
}

1.7. 获取布控全局陌生人的点位列表

基础信息

路径: /v1/api/pass/rule/query/unknownPoint

请求方法: POST

备注: 获取已经布控未知人员的点位列表,主要为了方便聚类布控查询可使用点位

请求参数

Headers:

名称 必须 备注
Content-Type application/json

Body:

名称 类型 必须 默认值 备注
pointName string 点位名称(支持模糊查)

Body示例:

{
  "pointName": "通道17"
}

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息
data array 具体的返回值
  |─ object
    |─pointUuid string 点位UUID
    |─pointName string 点位UUID
    |─pointType integer 点位类型 1.门禁点 2.监控点

响应示例:

{
    "code":0,
    "data":[
        {
            "pointName":"算力引擎1-通道17",
            "pointType":2,
            "pointUuid":"c132cdbb8b1a46a6aecf783b64719333"
        }
    ],
    "msg":"成功"
}

1.8. 修改布控启用状态

基础信息

路径: /v1/api/pass/rule/enable

请求方法: POST

备注: 修改布控启用状态

请求参数

Headers:

名称 必须 备注
Content-Type application/json

Body:

名称 类型 必须 默认值 备注
uuid string 人员布控uuid
enable integer 启用状态 1:启动,0:关闭

Body示例:

{
  "uuid": "7eab8c05da974509a189d7b6aaa81111",
  "enable":"0"
}

返回数据

Headers:

名称 必须 备注
content-type application/json;charset=UTF-8

Body:

名称 类型 必须 默认值 备注
code integer 返回值code
msg string 返回值消息

响应示例:

{
  "code": 0,
  "msg": "成功"
}

results matching ""

    No results matching ""