1. 安防人脸布控

安防人脸布控


1.1. 批量添加

基础信息

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

请求方法: POST

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

请求参数

Headers:

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

Body:

名称 类型 必须 默认值 备注
ruleList array 规则实体列表
  |─ object
    |─name string 规则名称
    |─typeList array 类型:1 关注人员,2 全局陌生人,3 基础人员,4 访客(兼容字段,新版本对接建议使用personRange)
      |─ integer
    |─personRange integer 布控人员范围 1.实名人员 2.未知人员(与typeList相同含义,如两者同时传递personRange优先级高)
    |─scheduleUUId string 时间计划uuid
    |─reportUnauthorizedFlag boolean false 是否上报未授权人员0不上报 1上报
    |─pointUuids array 分析源:必选,支持多选-只展示符合算力资源要求的监控点供用户选择,例如选择了算力资源为边端算力,分析源只展示B4H和C4H-240上报的监控点
* 规则类型为未知人员时分析源也可以选择面板机上报的门禁点
      |─ string
    |─groupUUidList array 选择人员组,基础人员、访客、关注人员必填,未知人员无需传递
      |─ string

Body示例:

{
    "ruleList": [
        {
            "name": "OPenAPi通道1实名人员布控",
            "ruleType": 1,
            "typeList": [
                1,
                3,
                4
            ],
            "scheduleUUId": "851b75f2d16b40a18b17e281b1f73333",
            "reportUnauthorizedFlag": true,
            "pointUuids": [
                "1984c42edda94dfb90be95dd34eef82e"
            ],
            "groupUUidList": [
                "d46893e0ad5546399e5c015b474e29ef"
            ]
        }
    ]
}

返回数据

Headers:

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

Body:

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

名称 类型 必须 默认值 备注
uuid string uuid
name string 规则名称
typeList array 类型:1 关注人员,2 全局陌生人,3 基础人员,4 访客(兼容字段,新版本对接建议使用personRange)
  |─ integer
personRange integer 布控人员范围 1.实名人员 2.未知人员(与typeList相同含义,如两者同时传递personRange优先级高)
scheduleUUId string 时间计划uuid
reportUnauthorizedFlag boolean false 是否上报未授权人员0不上报 1上报(typeList包含2或personRange=2时此值配置不生效)
pointUuids array 分析源-监控点
  |─ string
groupList array 选择人员组,基础人员、访客、关注人员必填,未知人员无需传递
  |─ string

Body示例:

{
    "uuid": "924d2940bc0e4339946f40baca19eb67",
    "name": "OPenAPi通道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 返回值code
msg string 返回值消息
data object 具体的返回值
  |─pageNum integer 页码,从1开始
当前页码
  |─pageSize integer 页面大小
分页大小
  |─total integer 总记录数
总数
  |─list array
    |─ object
      |─uuid string 布控Uuid
      |─name string 规则名称
规则名称
      |─personRange integer 人员范围(1实名人员 2未知人员 默认1)
布控人员范围 1.实名人员 2.未知人员 默认1
      |─scheduleUUId string 时间计划uuid
时间计划uuid
      |─reportUnauthorizedFlag boolean 是否上报未授权人员(0不上报 1上报)
是否上报未授权人员0不上报 1上报
      |─points array 分析源
分析源-监控点
        |─ object
          |─uuid string 监控点位Uuid
          |─name string 监控点位名称
      |─groups array 人员组
人员组
        |─ object
          |─uuid string 组Uuid
          |─name string 组名称
      |─schedule object 时间计划
时间计划
        |─uuid string 时间计划uuid
        |─name string 时间计划名称

响应示例:

{
    "code":0,
    "data":{
        "list":[
            {
                "groups":[
                    {
                        "name":"测试权限",
                        "uuid":"d46893e0ad5546399e5c015b474e29ef"
                    }
                ],
                "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 返回值code
msg string 返回值消息
data object 具体的返回值
  |─uuid string 规则UUID
  |─ruleName string 规则名称
  |─personRange integer 布控人员范围 1.实名人员 2.未知人员 默认1
  |─points array 分析源-监控点
    |─ object
      |─uuid string 监控点位Uuid
      |─name string 监控点位名称
  |─groups array 人员组
    |─ object
      |─uuid string 组Uuid
      |─name string 组名称
  |─scheduleDTO object 时间计划
    |─uuid string 时间计划uuid
    |─name string 时间计划名称
  |─reportUnauthorizedFlag boolean 是否上报未授权人员0不上报 1上报

响应示例:

{
    "code":0,
    "data":{
        "groups":[],
        "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":"成功"
}

results matching ""

    No results matching ""