Sparkle
  1. API
  2. BanHistory 封禁历史
Sparkle
  • API
    • BanHistory 封禁历史
      • 查询最近封禁记录
        GET
      • 复杂查询封禁记录
        POST
    • ClientDiscovery 客户端发现
      • 查询最近新客户端发现记录
      • 复杂查询客户端发现记录
    • Snapshot 快照记录
      • 查询最近快照
      • 复杂查询快照记录
    • UserApplication 用户应用程序
      • 列出我的用户应用程序
      • 获取指定用户应用程序信息
      • 重置指定用户应用程序的 AppSecret
      • 编辑指定用户应用程序
      • 创建新的用户应用程序
      • 删除指定用户应用程序
    • User 用户
      • 用户个人基本信息
      • 读取指定用户个人基本信息
      • 登出会话
    • Github OAuth2 登录
      GET
  • BTN兼容客户端协议通讯
    • 能力
      • 提交 Peers
      • 提交 Bans
      • 请求云端规则
    • 请求 BTN 配置文件
      GET
  1. API
  2. BanHistory 封禁历史

复杂查询封禁记录

开发中
POST
/api/banhistory/query

请求参数

Body 参数application/json
page
integer 
必需
pageSize
integer 
必需
timeFrom
integer 
开始时间
必需
timeTo
integer 
结束
必需
peerId
string 
可选
不使用查询条件时请勿传递此参数
peerIdCompareMethod
enum<string> 
字符串查询枚举
可选
不使用查询条件时请勿传递此参数
枚举值:
CONTAINSNOT_CONTAINSEQUALSNOT_EQUALSSTARTS_WITHNOT_STARTS_WITHENDS_WITHNOT_ENDS_WITH
peerClientName
string 
可选
不使用查询条件时请勿传递此参数
peerClientNameCompareMethod
enum<string> 
字符串查询枚举
可选
不使用查询条件时请勿传递此参数
枚举值:
CONTAINSNOT_CONTAINSEQUALSNOT_EQUALSSTARTS_WITHNOT_STARTS_WITHENDS_WITHNOT_ENDS_WITH
peerIp
string 
可选
不使用查询条件时请勿传递此参数
peerIpCompareMethod
enum<string> 
字符串查询枚举
可选
不使用查询条件时请勿传递此参数
枚举值:
CONTAINSNOT_CONTAINSEQUALSNOT_EQUALSSTARTS_WITHNOT_STARTS_WITHENDS_WITHNOT_ENDS_WITH
torrentIdentifier
string 
可选
不使用查询条件时请勿传递此参数
torrentIdentifierCompareMethod
enum<string> 
字符串查询枚举
可选
不使用查询条件时请勿传递此参数
枚举值:
CONTAINSNOT_CONTAINSEQUALSNOT_EQUALSSTARTS_WITHNOT_STARTS_WITHENDS_WITHNOT_ENDS_WITH
torrentSize
integer 
可选
不使用查询条件时请勿传递此参数
torrentSizeCompareMethod
enum<string> 
数值查询枚举
可选
不使用查询条件时请勿传递此参数
枚举值:
LESS_THANLESS_THAN_EQUALGREATER_THANGREATER_THAN_EQUALEQUAL
peerPort
integer 
可选
不使用查询条件时请勿传递此参数
peerPortCompareMethod
enum<string> 
数值查询枚举
可选
不使用查询条件时请勿传递此参数
枚举值:
LESS_THANLESS_THAN_EQUALGREATER_THANGREATER_THAN_EQUALEQUAL
fromPeerTraffic
integer 
可选
不使用查询条件时请勿传递此参数
fromPeerTrafficSpeedCompareMethod
enum<string> 
数值查询枚举
可选
不使用查询条件时请勿传递此参数
枚举值:
LESS_THANLESS_THAN_EQUALGREATER_THANGREATER_THAN_EQUALEQUAL
toPeerTraffic
string 
可选
不使用查询条件时请勿传递此参数
toPeerTrafficCompareMethod
enum<string> 
数值查询枚举
可选
不使用查询条件时请勿传递此参数
枚举值:
LESS_THANLESS_THAN_EQUALGREATER_THANGREATER_THAN_EQUALEQUAL
toPeerTrafficSpeed
string 
可选
不使用查询条件时请勿传递此参数
toPeerTrafficSpeedCompareMethod
enum<string> 
数值查询枚举
可选
不使用查询条件时请勿传递此参数
枚举值:
LESS_THANLESS_THAN_EQUALGREATER_THANGREATER_THAN_EQUALEQUAL
peerProgress
number 
可选
不使用查询条件时请勿传递此参数
peerProgressCompareMethod
enum<string> 
数值查询枚举
可选
不使用查询条件时请勿传递此参数
枚举值:
LESS_THANLESS_THAN_EQUALGREATER_THANGREATER_THAN_EQUALEQUAL
downloaderProgress
number 
可选
不使用查询条件时请勿传递此参数
downloaderProgressCompareMethod
enum<string> 
数值查询枚举
可选
不使用查询条件时请勿传递此参数
枚举值:
LESS_THANLESS_THAN_EQUALGREATER_THANGREATER_THAN_EQUALEQUAL
btnBan
boolean 
是否为 BTN 封禁
可选
不使用查询条件时请勿传递此参数
module
string 
封禁模块名称
可选
不使用查询条件时请勿传递此参数
moduleCompareMethod
enum<string> 
字符串查询枚举
可选
不使用查询条件时请勿传递此参数
枚举值:
CONTAINSNOT_CONTAINSEQUALSNOT_EQUALSSTARTS_WITHNOT_STARTS_WITHENDS_WITHNOT_ENDS_WITH
rule
string 
封禁规则内容
可选
不使用查询条件时请勿传递此参数
ruleCompareMethod
enum<string> 
字符串查询枚举
可选
不使用查询条件时请勿传递此参数
枚举值:
CONTAINSNOT_CONTAINSEQUALSNOT_EQUALSSTARTS_WITHNOT_STARTS_WITHENDS_WITHNOT_ENDS_WITH
orConnector
boolean 
是否使用 OR 条件连接
可选
不使用查询条件时请勿传递此参数
sortBy
array[string]
有序排序字段
可选
不使用查询条件时请勿传递此参数
sortOrder
string 
排序方式
可选
不使用查询条件时请勿传递此参数
示例
{
  "page": 0,
  "pageSize": 0,
  "timeFrom": 0,
  "timeTo": 0,
  "peerId": "string",
  "peerIdCompareMethod": "CONTAINS",
  "peerClientName": "string",
  "peerClientNameCompareMethod": "CONTAINS",
  "peerIp": "string",
  "peerIpCompareMethod": "CONTAINS",
  "torrentIdentifier": "string",
  "torrentIdentifierCompareMethod": "CONTAINS",
  "torrentSize": 0,
  "torrentSizeCompareMethod": "LESS_THAN",
  "peerPort": 0,
  "peerPortCompareMethod": "LESS_THAN",
  "fromPeerTraffic": 0,
  "fromPeerTrafficSpeedCompareMethod": "LESS_THAN",
  "toPeerTraffic": "string",
  "toPeerTrafficCompareMethod": "LESS_THAN",
  "toPeerTrafficSpeed": "string",
  "toPeerTrafficSpeedCompareMethod": "LESS_THAN",
  "peerProgress": 0,
  "peerProgressCompareMethod": "LESS_THAN",
  "downloaderProgress": 0,
  "downloaderProgressCompareMethod": "LESS_THAN",
  "btnBan": true,
  "module": "string",
  "moduleCompareMethod": "CONTAINS",
  "rule": "string",
  "ruleCompareMethod": "CONTAINS",
  "orConnector": true,
  "sortBy": [
    "string"
  ],
  "sortOrder": "string"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://btn-prod.ghostchu-services.top/api/banhistory/query' \
--header 'Content-Type: application/json' \
--data-raw ''

返回响应

🟢200成功
application/json
Body
success
boolean 
必需
message
null 
必需
data
object 
必需
page
integer 
必需
size
integer 
必需
total
integer 
必需
results
array[object (BanHistory) {18}] 
必需
示例
{
  "success": true,
  "message": null,
  "data": {
    "page": 1,
    "size": 10,
    "total": 55,
    "results": [
      {
        "id": 14,
        "appId": "7355608",
        "submitId": "fc39d793-601d-4a7b-aefb-67bc548bde36",
        "peerIp": "183.255.63.152",
        "peerPort": 16318,
        "peerId": "N/A",
        "peerClientName": "N/A",
        "torrent": {
          "id": 82,
          "identifier": "01884c9ea1b6f3953eb460cd36b647a3e171366aa15f2d207c3ea449c298cf26",
          "size": 3478482944
        },
        "fromPeerTraffic": 0,
        "fromPeerTrafficSpeed": 0,
        "toPeerTraffic": 0,
        "toPeerTrafficSpeed": 0,
        "peerProgress": 0,
        "downloaderProgress": 0.008628901875679284,
        "flags": "K ? I H",
        "btnBan": false,
        "module": "com.ghostchu.peerbanhelper.module.impl.rule.IPBlackRuleList",
        "rule": "匹配 IP黑名单订阅 规则: all-in-one, IP 地址: 183.255.63.152",
        "banUniqueId": "482e7baf-8f5e-4229-b727-c919b3a6b199"
      },
      {
        "id": 13,
        "appId": "7355608",
        "submitId": "b690174b-ddbe-4675-8213-49a68a3e5910",
        "peerIp": "113.137.59.149",
        "peerPort": 6778,
        "peerId": "N/A",
        "peerClientName": "N/A",
        "torrent": {
          "id": 2,
          "identifier": "4a2ff1df70469bf2059e83f805ba3136d76e63aead37b6c659c4f6503d30f5b1",
          "size": 8959565524
        },
        "fromPeerTraffic": 0,
        "fromPeerTrafficSpeed": 0,
        "toPeerTraffic": 0,
        "toPeerTrafficSpeed": 0,
        "peerProgress": 0,
        "downloaderProgress": 0.003269644261379476,
        "flags": "K ? I H",
        "btnBan": false,
        "module": "com.ghostchu.peerbanhelper.module.impl.rule.IPBlackRuleList",
        "rule": "匹配 IP黑名单订阅 规则: all-in-one, IP 地址: 113.137.59.149",
        "banUniqueId": "6c581c19-6366-45cb-ab73-fbd8fc0b34be"
      },
      {
        "id": 12,
        "appId": "7355608",
        "submitId": "1c163539-cffa-4303-b2d0-f46db95e3d0f",
        "peerIp": "212.102.35.5",
        "peerPort": 29696,
        "peerId": "N/A",
        "peerClientName": "N/A",
        "torrent": {
          "id": 1,
          "identifier": "ab2c7797616c4f6dce08012107fb6ded03f0f292eeacc3b2655b50dda766605e",
          "size": 516225531
        },
        "fromPeerTraffic": 0,
        "fromPeerTrafficSpeed": 0,
        "toPeerTraffic": 0,
        "toPeerTrafficSpeed": 0,
        "peerProgress": 0,
        "downloaderProgress": 0.1761115433866443,
        "flags": "K ? I H",
        "btnBan": false,
        "module": "com.ghostchu.peerbanhelper.module.impl.rule.IPBlackRuleList",
        "rule": "匹配 IP黑名单订阅 规则: all-in-one, IP 地址: 212.102.35.5",
        "banUniqueId": "84c6f9ec-688f-48e1-bc44-cfaee8329bd3"
      },
      {
        "id": 15,
        "appId": "7355608",
        "submitId": "eb45fafc-357f-4efd-9602-6a4bf5dddbed",
        "peerIp": "113.200.3.105",
        "peerPort": 2051,
        "peerId": "N/A",
        "peerClientName": "N/A",
        "torrent": {
          "id": 50,
          "identifier": "5acddda3de5ca94c8792205eabed22547b595dfa80dc048ad2e20b559e835ca3",
          "size": 9621809032
        },
        "fromPeerTraffic": 0,
        "fromPeerTrafficSpeed": 0,
        "toPeerTraffic": 0,
        "toPeerTrafficSpeed": 0,
        "peerProgress": 0,
        "downloaderProgress": 0.00454987704021187,
        "flags": "K ? I",
        "btnBan": false,
        "module": "com.ghostchu.peerbanhelper.module.impl.rule.IPBlackRuleList",
        "rule": "匹配 IP黑名单订阅 规则: all-in-one, IP 地址: 113.200.3.105",
        "banUniqueId": "99b5aafd-dd54-444d-9992-c7aba6f24dd3"
      },
      {
        "id": 16,
        "appId": "7355608",
        "submitId": "1c12d6e6-e15d-4163-91ba-acdc9b2b007e",
        "peerIp": "112.46.3.58",
        "peerPort": 2084,
        "peerId": "N/A",
        "peerClientName": "N/A",
        "torrent": {
          "id": 8,
          "identifier": "4e79d2adc1443aa6213bd8408ed9bb2ac76afbb36cfe8e8268f291ac2ac490af",
          "size": 425122498
        },
        "fromPeerTraffic": 0,
        "fromPeerTrafficSpeed": 0,
        "toPeerTraffic": 0,
        "toPeerTrafficSpeed": 0,
        "peerProgress": 0,
        "downloaderProgress": 0.014375226031909513,
        "flags": "K ? I",
        "btnBan": false,
        "module": "com.ghostchu.peerbanhelper.module.impl.rule.IPBlackRuleList",
        "rule": "匹配 IP黑名单订阅 规则: all-in-one, IP 地址: 112.46.3.58",
        "banUniqueId": "e1521a63-3d05-4b98-86df-24b0df445803"
      },
      {
        "id": 11,
        "appId": "7355608",
        "submitId": "0e8c3e9d-5584-431b-a527-0eab5af0a03a",
        "peerIp": "112.46.3.52",
        "peerPort": 2084,
        "peerId": "N/A",
        "peerClientName": "N/A",
        "torrent": {
          "id": 8,
          "identifier": "4e79d2adc1443aa6213bd8408ed9bb2ac76afbb36cfe8e8268f291ac2ac490af",
          "size": 425122498
        },
        "fromPeerTraffic": 0,
        "fromPeerTrafficSpeed": 0,
        "toPeerTraffic": 0,
        "toPeerTrafficSpeed": 0,
        "peerProgress": 0,
        "downloaderProgress": 0.014336686551931203,
        "flags": "K ? I",
        "btnBan": false,
        "module": "com.ghostchu.peerbanhelper.module.impl.rule.IPBlackRuleList",
        "rule": "匹配 IP黑名单订阅 规则: all-in-one, IP 地址: 112.46.3.52",
        "banUniqueId": "8b6465e8-6f5c-45bb-90ed-a227e4429497"
      },
      {
        "id": 17,
        "appId": "7355608",
        "submitId": "1b8ae9d0-a47c-4045-a3fc-e09648114246",
        "peerIp": "177.245.155.77",
        "peerPort": 16286,
        "peerId": "N/A",
        "peerClientName": "N/A",
        "torrent": {
          "id": 2,
          "identifier": "4a2ff1df70469bf2059e83f805ba3136d76e63aead37b6c659c4f6503d30f5b1",
          "size": 8959565524
        },
        "fromPeerTraffic": 0,
        "fromPeerTrafficSpeed": 0,
        "toPeerTraffic": 0,
        "toPeerTrafficSpeed": 0,
        "peerProgress": 0,
        "downloaderProgress": 0.0032751302416838043,
        "flags": "K ? I H",
        "btnBan": false,
        "module": "com.ghostchu.peerbanhelper.module.impl.rule.IPBlackRuleList",
        "rule": "匹配 IP黑名单订阅 规则: all-in-one, IP 地址: 177.245.155.77",
        "banUniqueId": "b74fccde-5c9d-4f36-ab1b-cfbb238d1081"
      },
      {
        "id": 18,
        "appId": "7355608",
        "submitId": "b249054f-6c6a-40ed-8997-c62bde71d94c",
        "peerIp": "2409:8a62:6017:f450:48e1:2110:cabf:37a1",
        "peerPort": 63746,
        "peerId": "-XL0019-",
        "peerClientName": "Xunlei 0.0.1.9",
        "torrent": {
          "id": 9,
          "identifier": "b0eaafa5ee19da5438cf58d8bf8d7c9f10732278f7d715de0648e7ca7c639934",
          "size": 7133401088
        },
        "fromPeerTraffic": 0,
        "fromPeerTrafficSpeed": 0,
        "toPeerTraffic": 0,
        "toPeerTrafficSpeed": 0,
        "peerProgress": 0,
        "downloaderProgress": 0.013020562681698461,
        "flags": "K ? I E",
        "btnBan": false,
        "module": "com.ghostchu.peerbanhelper.module.impl.rule.ClientNameBlacklist",
        "rule": "匹配 ClientName (UserAgent): StringContainsMatcher(super=AbstractJsonMatcher(condition=null), rule=xunlei, hit=TRUE, miss=DEFAULT)",
        "banUniqueId": "366c7522-2756-4894-82e0-5c7148c777c0"
      },
      {
        "id": 20,
        "appId": "7355608",
        "submitId": "4e8fbbd3-2dc9-4273-b5a5-922018c73d96",
        "peerIp": "113.137.59.167",
        "peerPort": 2041,
        "peerId": "N/A",
        "peerClientName": "N/A",
        "torrent": {
          "id": 4,
          "identifier": "e39a9920ba61ae5ac840d53cb2b6b692d03bb629d29fca632585a01330b51f69",
          "size": 17406575718
        },
        "fromPeerTraffic": 0,
        "fromPeerTrafficSpeed": 0,
        "toPeerTraffic": 0,
        "toPeerTrafficSpeed": 0,
        "peerProgress": 0,
        "downloaderProgress": 0.001523889386961388,
        "flags": "K ? I",
        "btnBan": false,
        "module": "com.ghostchu.peerbanhelper.module.impl.rule.IPBlackRuleList",
        "rule": "匹配 IP黑名单订阅 规则: all-in-one, IP 地址: 113.137.59.167",
        "banUniqueId": "1d623f01-d500-42dd-bc79-35c11d0f4fcc"
      },
      {
        "id": 19,
        "appId": "7355608",
        "submitId": "25ceedca-9621-4e05-8eb2-e15c5f36c095",
        "peerIp": "113.137.59.68",
        "peerPort": 7984,
        "peerId": "N/A",
        "peerClientName": "N/A",
        "torrent": {
          "id": 12,
          "identifier": "b08485c02d9302b7b17f0b1f16f0da4437ff12a505d7a71f4d7b9945dca47cb3",
          "size": 251539593
        },
        "fromPeerTraffic": 0,
        "fromPeerTrafficSpeed": 0,
        "toPeerTraffic": 0,
        "toPeerTrafficSpeed": 0,
        "peerProgress": 0,
        "downloaderProgress": 0.01491588642269927,
        "flags": "K ? I H",
        "btnBan": false,
        "module": "com.ghostchu.peerbanhelper.module.impl.rule.IPBlackRuleList",
        "rule": "匹配 IP黑名单订阅 规则: all-in-one, IP 地址: 113.137.59.68",
        "banUniqueId": "7a31c428-ff50-4ba7-91b5-ffda559743a2"
      }
    ]
  }
}
修改于 2024-08-18 09:13:26
上一页
查询最近封禁记录
下一页
查询最近新客户端发现记录
Built with