dujiabo
/
zhongyouweb
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
18 Commits
1 Branch
0 Tags
4.4 MiB
 
 
 
 
Tree: c1481ca6c6
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'c1481ca6c6'
${ noResults }
zhongyouweb/docs/api/modules/13-anti-farm-config.md

23 KiB
Raw Blame History

防刷分管控配置

本模块共 18 个接口。源文件：api.json。

快速索引

接口名称 方法 路径 用途
获取启用的防刷配置 GET /gd_dataserver/business/points/anti/farm/active 返回 data 为 AntiFarmConfig 对象，包含当前生效的防刷规则配置。
新增 POST /gd_dataserver/business/points/anti/farm/add 新增单条记录，请求体为实体类对象（字段说明见对应实体模型）。成功返回 data 为 null。
批量新增 POST /gd_dataserver/business/points/anti/farm/addBatch 批量新增多条记录，请求体为实体类数组。成功返回 data 为 null。
新增并返回保存的数据 POST /gd_dataserver/business/points/anti/farm/addReturn 新增单条记录并返回保存后的数据（含自增ID），请求体为实体类对象。成功返回 data 为保存的实体对象。
根据属性删除 GET /gd_dataserver/business/points/anti/farm/delete 根据实体属性条件删除记录，请求体为实体类对象。成功返回 data 为 null。
主键删除 GET /gd_dataserver/business/points/anti/farm/deleteById 根据主键ID删除单条记录，成功返回 data 为 null。
批量删除 GET /gd_dataserver/business/points/anti/farm/deleteByIds 根据ID列表批量删除记录，成功返回 data 为 null。
异常行为一键检测 GET /gd_dataserver/business/points/anti/farm/detectAll 对指定用户执行全维度异常行为检测，聚合4类防刷校验（上报/积分获取/兑换）。返回 data 为对象，包含：userId-被检测用户ID、reportCheck-上报检测结果{passed-是否通过,reason-原因}、pointsEarnCheck-积分获取检测结果{passed,reason}、exchangeCheck-兑换检测结果{passed,reason}、overallPassed-综合是否通过(boolean)。
检测自报自审行为 GET /gd_dataserver/business/points/anti/farm/detectSelfAudit 检测上报人和审核人是否为同一人。返回 data 为字符串，检测到异常时返回'检测到自报自审行为'，正常时返回'未检测到异常'。
查询所有 GET /gd_dataserver/business/points/anti/farm/getAll 查询所有记录（无分页、无条件）。成功返回 data 为实体类数组。
分页查询 GET /gd_dataserver/business/points/anti/farm/getListByPage 分页查询记录列表，查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象，其中 list 为实体类数组。
详情 GET /gd_dataserver/business/points/anti/farm/info 根据主键ID查询单条记录详情。成功返回 data 为实体类对象，包含该实体所有字段。
条件查询 GET /gd_dataserver/business/points/anti/farm/list 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。
逻辑删除 GET /gd_dataserver/business/points/anti/farm/removeById 根据主键ID逻辑删除单条记录，成功返回 data 为 null。
修改 POST /gd_dataserver/business/points/anti/farm/updateById 根据主键ID修改记录，请求体为实体类对象（需包含id字段）。成功返回 data 为 null。
校验兑换是否触发防刷 GET /gd_dataserver/business/points/anti/farm/validateExchange 返回 data 为对象，包含：triggered-是否触发、reason-触发原因。
校验积分获取是否触发防刷 GET /gd_dataserver/business/points/anti/farm/validatePointsEarn 返回 data 为对象，包含：triggered-是否触发、reason-触发原因。
校验上报是否触发防刷 GET /gd_dataserver/business/points/anti/farm/validateReport 返回 data 为对象，包含：triggered-是否触发(boolean)、reason-触发原因。前端在上报前调用，若 triggered=true 则提示用户。

接口详情

获取启用的防刷配置

  • 用途： 返回 data 为 AntiFarmConfig 对象，包含当前生效的防刷规则配置。
  • 请求： GET /gd_dataserver/business/points/anti/farm/active
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： getActiveConfigUsingGET

参数：

无

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

新增

  • 用途： 新增单条记录，请求体为实体类对象（字段说明见对应实体模型）。成功返回 data 为 null。
  • 请求： POST /gd_dataserver/business/points/anti/farm/add
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： addOneUsingPOST_1

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：防刷分管控配置
  • 必填：文档未标记
字段 必填 类型 说明 示例
configName 否 string 配置名称 -
createTime 否 string / date-time 创建时间 -
dailyPointsEarnLimit 否 integer / int32 每人每日积分获取上限 -
dailyReportLimit 否 integer / int32 每人每日上报次数上限 -
enabled 否 integer / int32 是否启用：1-启用 0-禁用 -
id 否 integer / int64 主键ID -
ipExchangeDailyLimit 否 integer / int32 同一IP每日兑换上限 -
remark 否 string 备注 -
reportIntervalMinutes 否 integer / int32 两次上报最小间隔（分钟） -
sameItemDailyLimit 否 integer / int32 同一商品每人每日兑换上限 -
sameLocationReportLimit 否 integer / int32 同一地点上报次数上限（每日） -
sameReporterAuditLimit 否 integer / int32 同一上报人每日通过审核次数上限 -
selfReportCheckEnabled 否 integer / int32 是否启用自报自审检测：1-是 0-否 -
updateTime 否 string / date-time 更新时间 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -

批量新增

  • 用途： 批量新增多条记录，请求体为实体类数组。成功返回 data 为 null。
  • 请求： POST /gd_dataserver/business/points/anti/farm/addBatch
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： addBatchUsingPOST_1

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：array<防刷分管控配置>
  • 必填：文档未标记

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -

新增并返回保存的数据

  • 用途： 新增单条记录并返回保存后的数据（含自增ID），请求体为实体类对象。成功返回 data 为保存的实体对象。
  • 请求： POST /gd_dataserver/business/points/anti/farm/addReturn
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： addReturnUsingPOST_1

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：防刷分管控配置
  • 必填：文档未标记
字段 必填 类型 说明 示例
configName 否 string 配置名称 -
createTime 否 string / date-time 创建时间 -
dailyPointsEarnLimit 否 integer / int32 每人每日积分获取上限 -
dailyReportLimit 否 integer / int32 每人每日上报次数上限 -
enabled 否 integer / int32 是否启用：1-启用 0-禁用 -
id 否 integer / int64 主键ID -
ipExchangeDailyLimit 否 integer / int32 同一IP每日兑换上限 -
remark 否 string 备注 -
reportIntervalMinutes 否 integer / int32 两次上报最小间隔（分钟） -
sameItemDailyLimit 否 integer / int32 同一商品每人每日兑换上限 -
sameLocationReportLimit 否 integer / int32 同一地点上报次数上限（每日） -
sameReporterAuditLimit 否 integer / int32 同一上报人每日通过审核次数上限 -
selfReportCheckEnabled 否 integer / int32 是否启用自报自审检测：1-是 0-否 -
updateTime 否 string / date-time 更新时间 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -

根据属性删除

  • 用途： 根据实体属性条件删除记录，请求体为实体类对象。成功返回 data 为 null。
  • 请求： GET /gd_dataserver/business/points/anti/farm/delete
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： deleteUsingGET_1

参数：

字段 位置 必填 类型 说明 示例
configName query 否 string 配置名称 -
createTime query 否 string / date-time 创建时间 -
dailyPointsEarnLimit query 否 integer / int32 每人每日积分获取上限 -
dailyReportLimit query 否 integer / int32 每人每日上报次数上限 -
enabled query 否 integer / int32 是否启用：1-启用 0-禁用 -
id query 否 integer / int64 主键ID -
ipExchangeDailyLimit query 否 integer / int32 同一IP每日兑换上限 -
remark query 否 string 备注 -
reportIntervalMinutes query 否 integer / int32 两次上报最小间隔（分钟） -
sameItemDailyLimit query 否 integer / int32 同一商品每人每日兑换上限 -
sameLocationReportLimit query 否 integer / int32 同一地点上报次数上限（每日） -
sameReporterAuditLimit query 否 integer / int32 同一上报人每日通过审核次数上限 -
selfReportCheckEnabled query 否 integer / int32 是否启用自报自审检测：1-是 0-否 -
updateTime query 否 string / date-time 更新时间 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

主键删除

  • 用途： 根据主键ID删除单条记录，成功返回 data 为 null。
  • 请求： GET /gd_dataserver/business/points/anti/farm/deleteById
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： deleteOneUsingGET_1

参数：

字段 位置 必填 类型 说明 示例
id query 是 string 主键ID -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

批量删除

  • 用途： 根据ID列表批量删除记录，成功返回 data 为 null。
  • 请求： GET /gd_dataserver/business/points/anti/farm/deleteByIds
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： deleteListUsingGET_3

参数：

字段 位置 必填 类型 说明 示例
ids query 是 string ID列表(逗号分隔) -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

异常行为一键检测

  • 用途： 对指定用户执行全维度异常行为检测，聚合4类防刷校验（上报/积分获取/兑换）。返回 data 为对象，包含：userId-被检测用户ID、reportCheck-上报检测结果{passed-是否通过,reason-原因}、pointsEarnCheck-积分获取检测结果{passed,reason}、exchangeCheck-兑换检测结果{passed,reason}、overallPassed-综合是否通过(boolean)。
  • 请求： GET /gd_dataserver/business/points/anti/farm/detectAll
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： detectAllUsingGET

参数：

字段 位置 必填 类型 说明 示例
userId query 是 integer / int64 被检测用户ID -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

检测自报自审行为

  • 用途： 检测上报人和审核人是否为同一人。返回 data 为字符串，检测到异常时返回'检测到自报自审行为'，正常时返回'未检测到异常'。
  • 请求： GET /gd_dataserver/business/points/anti/farm/detectSelfAudit
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： detectSelfAuditUsingGET

参数：

字段 位置 必填 类型 说明 示例
reporterId query 是 integer / int64 上报人ID -
auditorId query 是 integer / int64 审核人ID -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

查询所有

  • 用途： 查询所有记录（无分页、无条件）。成功返回 data 为实体类数组。
  • 请求： GET /gd_dataserver/business/points/anti/farm/getAll
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： getAllUsingGET_1

参数：

无

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

分页查询

  • 用途： 分页查询记录列表，查询条件为实体类字段。成功返回 data 为 PageInfo 分页对象，其中 list 为实体类数组。
  • 请求： GET /gd_dataserver/business/points/anti/farm/getListByPage
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： getListByPageUsingGET_1

参数：

字段 位置 必填 类型 说明 示例
configName query 否 string 配置名称 -
createTime query 否 string / date-time 创建时间 -
dailyPointsEarnLimit query 否 integer / int32 每人每日积分获取上限 -
dailyReportLimit query 否 integer / int32 每人每日上报次数上限 -
enabled query 否 integer / int32 是否启用：1-启用 0-禁用 -
id query 否 integer / int64 主键ID -
ipExchangeDailyLimit query 否 integer / int32 同一IP每日兑换上限 -
pageNum query 是 integer / int32 页码 -
remark query 否 string 备注 -
reportIntervalMinutes query 否 integer / int32 两次上报最小间隔（分钟） -
sameItemDailyLimit query 否 integer / int32 同一商品每人每日兑换上限 -
sameLocationReportLimit query 否 integer / int32 同一地点上报次数上限（每日） -
sameReporterAuditLimit query 否 integer / int32 同一上报人每日通过审核次数上限 -
selfReportCheckEnabled query 否 integer / int32 是否启用自报自审检测：1-是 0-否 -
updateTime query 否 string / date-time 更新时间 -
pageSize query 是 integer / int32 每页条数 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

详情

  • 用途： 根据主键ID查询单条记录详情。成功返回 data 为实体类对象，包含该实体所有字段。
  • 请求： GET /gd_dataserver/business/points/anti/farm/info
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： infoUsingGET_1

参数：

字段 位置 必填 类型 说明 示例
id query 是 string 主键ID -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

条件查询

  • 用途： 根据实体属性条件查询记录列表。成功返回 data 为实体类数组。
  • 请求： GET /gd_dataserver/business/points/anti/farm/list
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： getListUsingGET_1

参数：

字段 位置 必填 类型 说明 示例
configName query 否 string 配置名称 -
createTime query 否 string / date-time 创建时间 -
dailyPointsEarnLimit query 否 integer / int32 每人每日积分获取上限 -
dailyReportLimit query 否 integer / int32 每人每日上报次数上限 -
enabled query 否 integer / int32 是否启用：1-启用 0-禁用 -
id query 否 integer / int64 主键ID -
ipExchangeDailyLimit query 否 integer / int32 同一IP每日兑换上限 -
remark query 否 string 备注 -
reportIntervalMinutes query 否 integer / int32 两次上报最小间隔（分钟） -
sameItemDailyLimit query 否 integer / int32 同一商品每人每日兑换上限 -
sameLocationReportLimit query 否 integer / int32 同一地点上报次数上限（每日） -
sameReporterAuditLimit query 否 integer / int32 同一上报人每日通过审核次数上限 -
selfReportCheckEnabled query 否 integer / int32 是否启用自报自审检测：1-是 0-否 -
updateTime query 否 string / date-time 更新时间 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

逻辑删除

  • 用途： 根据主键ID逻辑删除单条记录，成功返回 data 为 null。
  • 请求： GET /gd_dataserver/business/points/anti/farm/removeById
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： deleteListUsingGET_2

参数：

字段 位置 必填 类型 说明 示例
id query 是 string 主键ID -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

修改

  • 用途： 根据主键ID修改记录，请求体为实体类对象（需包含id字段）。成功返回 data 为 null。
  • 请求： POST /gd_dataserver/business/points/anti/farm/updateById
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： updateByIdUsingPOST_1

参数：

无

请求体：

  • Content-Type：application/json
  • 模型：防刷分管控配置
  • 必填：文档未标记
字段 必填 类型 说明 示例
configName 否 string 配置名称 -
createTime 否 string / date-time 创建时间 -
dailyPointsEarnLimit 否 integer / int32 每人每日积分获取上限 -
dailyReportLimit 否 integer / int32 每人每日上报次数上限 -
enabled 否 integer / int32 是否启用：1-启用 0-禁用 -
id 否 integer / int64 主键ID -
ipExchangeDailyLimit 否 integer / int32 同一IP每日兑换上限 -
remark 否 string 备注 -
reportIntervalMinutes 否 integer / int32 两次上报最小间隔（分钟） -
sameItemDailyLimit 否 integer / int32 同一商品每人每日兑换上限 -
sameLocationReportLimit 否 integer / int32 同一地点上报次数上限（每日） -
sameReporterAuditLimit 否 integer / int32 同一上报人每日通过审核次数上限 -
selfReportCheckEnabled 否 integer / int32 是否启用自报自审检测：1-是 0-否 -
updateTime 否 string / date-time 更新时间 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
201 Created -
401 Unauthorized -
403 Forbidden -
404 Not Found -

校验兑换是否触发防刷

  • 用途： 返回 data 为对象，包含：triggered-是否触发、reason-触发原因。
  • 请求： GET /gd_dataserver/business/points/anti/farm/validateExchange
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： validateExchangeUsingGET

参数：

字段 位置 必填 类型 说明 示例
userId query 是 integer / int64 用户ID -
itemId query 是 integer / int64 物品ID -
ip query 否 string IP地址 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

校验积分获取是否触发防刷

  • 用途： 返回 data 为对象，包含：triggered-是否触发、reason-触发原因。
  • 请求： GET /gd_dataserver/business/points/anti/farm/validatePointsEarn
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： validatePointsEarnUsingGET

参数：

字段 位置 必填 类型 说明 示例
reporterId query 是 integer / int64 上报人ID -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -

校验上报是否触发防刷

  • 用途： 返回 data 为对象，包含：triggered-是否触发(boolean)、reason-触发原因。前端在上报前调用，若 triggered=true 则提示用户。
  • 请求： GET /gd_dataserver/business/points/anti/farm/validateReport
  • 鉴权： X-Access-Token（以接口定义为准）
  • operationId： validateReportUsingGET

参数：

字段 位置 必填 类型 说明 示例
userId query 是 integer / int64 用户ID -
location query 否 string 上报地点 -

响应：

状态码 说明 响应模型
200 OK /: object<string, object>
401 Unauthorized -
403 Forbidden -
404 Not Found -