PeerBanHelper WebAPI
  1. 下载器
PeerBanHelper WebAPI
  • API
    • 鉴权
      • 登录
      • 注销登录态
    • 元数据
      • 请求基本清单数据
      • 初始化
    • 基本统计
      • 统计计数器
      • 规则计数器
    • 封禁
      • 获取封禁列表
      • 获取封禁历史记录信息
      • 获取封禁排名
      • 解除封禁
    • 下载器
      • 获取下载器列表
        GET
      • 获取下载器元数据
        GET
      • 获取下载器种子列表
        GET
      • 获取下载器指定种子的Peers列表
        GET
      • 创建下载器
        PUT
      • 编辑下载器
        PATCH
      • 测试下载器配置
        POST
      • 删除下载器
        DELETE
    • 推送渠道
      • 获取推送渠道列表
      • 获取推送渠道元数据
      • 创建推送渠道
      • 编辑推送渠道
      • 测试通知渠道
      • 删除推送渠道
    • 通用
      • 通用状态查询
      • 创建堆转储文件
      • 检查指定模块是否启用
      • 更改全局设置
      • 获取全局设置
      • 配置文件重载
    • 功能模块
      • AutoRangeBan
        • 获取模块内存基本元数据
      • BtnNetworkOnline
        • 获取 BTN 模块状态
      • ClientNameBlackList
        • 获取模块内存基本元数据
      • IPBlackList
        • 获取模块内存基本元数据
        • 测试IP黑名单规则
        • 添加IP黑名单规则
        • 删除IP黑名单规则
        • 添加端口黑名单规则
        • 删除端口黑名单规则
        • 添加ASN黑名单
        • 删除ASN黑名单规则
        • 添加国家/地区代码黑名单规则
        • 添加城市黑名单规则
        • 删除国家/地区代码黑名单规则
        • 删除城市黑名单规则
      • MultiDialingBlocker
        • 获取模块内存基本元数据
      • PeerIdBlacklist
        • 获取模块内存基本元数据
      • ProgressCheatBlocker
        • 获取模块内存基本元数据
        • 获取状态
      • 订阅规则
        • 查询更新间隔
        • 修改更新间隔
        • 新增订阅规则
        • 查询订阅规则
        • 更新订阅规则
        • 保存订阅规则
        • 删除订阅规则
        • 启用禁用规则
        • 订阅规则列表
        • 更新全部订阅规则
        • 查询全部订阅规则更新日志
        • 查询指定订阅规则更新日志
      • Friend
        • 未命名接口
      • Expression Engine
        • 列出所有脚本
        • 获取指定脚本内容
        • 创建/保存脚本
        • 删除指定脚本
        • 是否可编辑给定脚本
      • Laboratory
        • 列出所有实验状态
        • 检查指定实验是否已启用
        • 设置指定实验的开关状态
        • 获取实验室模块配置状态
        • 设置实验室模块配置状态
      • PTRBlacklist
    • 警报
      • 获取警报列表
      • 标记警报为已读
      • 标记警报为全部已读
      • 删除指定警报
    • 程序日志
      • 连接到日志 WebSocket
      • 获取程序日志
    • 统计图表(基础)
      • 封禁趋势统计(迁移自/api/statistic/analysis/date)
      • 统计通用数值查询
      • 统计通用日期归类查询
    • PBH Plus
      • 创建或更新免费许可证
      • 验证捐赠密钥状态
      • 设置捐赠密钥
    • Torrent
      • 获取PBH种子列表
      • 获取指定种子基本信息
      • 获取指定种子的访问历史列表
      • 获取指定种子的封禁历史列表
    • 图表
      • GeoIP
      • 趋势
      • 流量
    • Peer
      • 查询指定 IP 的基本信息
      • 查询指定 IP 的访问历史列表
      • 查询指定 IP 的封禁记录
    • 工具
      • 批量更换 Tracker
  • 下载器兼容层
    • IP BanList 提供端点
      GET
    • P2P Guard Plain BanList 提供端点
      GET
    • DAT/Emule BanList 提供端点
      GET
  1. 下载器

获取下载器元数据

GET
/api/downloaders/{downloaderName}/status

请求参数

Authorization
在 Header 添加参数
Authorization
,其值为在 Bearer 之后拼接 Token
示例:
Authorization: Bearer ********************
Path 参数
downloaderName
string 
必需
示例值:
qbittorrent-001

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'http://127.0.0.1:9897/api/downloaders/qbittorrent-001/status'

返回响应

🟢200成功
application/json
Body
lastStatus
string 
最后状态
必需
可为 HEALTHY;ERROR;UNKNOWN 中的任意一个
lastStatusMessage
string 
状态正常
必需
activeTorrents
integer 
活跃种子数
必需
activePeers
integer 
活跃 Peers 数
必需
config
object 
下载器配置
必需
paused
string 
是否已暂停
必需
示例
{
  "lastStatus": "NEED_TAKE_ACTION",
  "lastStatusMessage": "在连接 BitComet 下载器时,PBH 需要请求权限提升。\n可能是网络问题、下载器已关闭或者猫咬断了网线。\n尝试原地旋转 360° 并用右手以 45° 角以适当力度敲击 BitComet 所在的设备。这段话只是为了证明它可以写的很长。",
  "activeTorrents": 3,
  "activePeers": 64,
  "config": {}
}
🟠429IP地址因频繁失败尝试而被封禁
🟠403未登录或Token错误
🔴500内部服务器错误
上一页
获取下载器列表
下一页
获取下载器种子列表
Built with