转租预警服务使用手册
更新时间:2019-12-07 22:11:18
概述
转租预警服务,基于人脸门禁或其他传统门禁的通行记录数据,对过去一段时间每个用户的通行频率进行分析,并按照预设的阈值,提取低频用户并发出通知。
使用方法
服务目前支持以下配置参数:
参数 | 业务含义 |
---|---|
rootSpaceId | 根空间ID,用于实现租户下的业务隔离 |
exeTime | 执行时间,通行记录分析任务每天定时执行一次,该参数用于指定执行时间 |
analyseDays | 分析天数,分析过去N天的通行记录,N≤180 |
analyseDaysMin | 最小分析天数,用户信息录入天数小于此值的不纳入分析范围 |
passThreshold | 最小通行次数,小于此值则认为是“低频”用户 |
userRoleList | 需要分析的用户角色列表 |
enabled | 是否启用,作为定时任务的开关使用 |
平台提供了开放API,可以对以上配置进行增删改查,参考:转租预警服务API
分析任务的执行结果数据通过数据总线输出,客户需要通过数据查询API查询结果,使用方法参考:https://help.aliyun.com/document_detail/114862.html#h2-4-2-api2,其中modelId="userPassStat"。
如需实时获取每天的分析结果通知,可以使用数据订阅服务,使用方法参考:业务数据订阅服务,其中Topic: /sys/uid/${aliyunUid}/homelink/pra/result,messageType: USER_PASS_STAT。
如需查询分析任务的执行历史,可以参考API:转租预警服务API-查询分析任务执行历史。
数据模型
分析结果通知
主题/sys/uid/${aliyunUid}/homelink/pra/result的消息体格式:
{
"data": {
"jobName": "xxxx",
"jobDate": "YYYYMMDD",
"status": "success|failed",
"errorMessage": "xxxx",
"resultModelId": "modelId",
"resultCount": 1
},
"messageType": "USER_PASS_STAT",
"gmtCreate": 1565578603511
}
分析结果内容
数据模型userPassStat
属性名称 | 属性标识符 | 数据类型 | 长度限制 | 数据描述 | 是否必须 |
---|---|---|---|---|---|
分析任务名称 | jobName | String | 64 | 是 | |
分析时间 | jobDate | String | 任务日期,格式YYYYMMDD | 是 | |
根空间ID | rootSpaceId | String | 64 | 根空间ID | 是 |
用户ID | userId | String | 64 | 用户ID | 是 |
用户类型 | userType | String | 16 | 用户类型,IDENTITY_ID、OPEN_ID | 是 |
用户姓名 | userName | String | 64 | 用户姓名 | 是 |
用户角色 | userRole | Integer | 用户角色 | 是 | |
通行次数 | effectivePassCount | Integer | 有效通行次数 | 是 | |
开始时间 | startTime | Date | 统计开始时间 | 是 | |
结束时间 | endTime | Date | 统计结束时间 | 是 |
基于平台设备的解决方案
基于平台设备的解决方案,是指人脸门禁设备接入了阿里云IoT平台,并通过平台提供的开放API进行人脸数据的保存和下发,然后配置分析任务实现通行记录分析。此解决方案需要客户完成以下步骤:
- 人脸识别设备接入平台并实现人脸数据的保存和下发,具体参考:人脸门禁边缘解决方案使用手册
- 通过绑定公区设备和绑定设备与空间的接口,把人脸识别设备绑定到空间,以便用根空间ID实现业务隔离。如果不完成这一步,设备上的人脸数据将被归入默认的根空间(rootSpaceId="DEFAULT"),无法按每个空间的隔离维度进行数据分析
- 按照《使用方法》的描述,配置分析任务并获取执行结果通知和执行结果数据
基于自有设备的解决方案
基于自有设备的解决方案,是指门禁设备不接入阿里云IoT平台,分析服务使用的源数据需要客户提供,然后配置分析任务实现通行记录分析。此解决方案需要客户完成以下步骤:
- 参考数据总线文档,把人脸数据和通行数据实时上报到数据总线
- 人脸数据modelId: passUserInfo
- 通行数据modelId: iotx_face_record_model
- 按照《使用方法》的描述,配置分析任务并获取执行结果通知和执行结果数据
方案对比
解决方案 | 基于平台设备 | 基于自有设备 |
---|---|---|
是否需要设备接入 | 是 | 否 |
是否需要客户上报通行数据 | 否 | 是 |
目前平台提供了完善的人脸门禁解决方案,推荐使用基于平台设备的解决方案实现数据分析。