[TOC]
## 获取过滤器列表
~~~[api]
get:/v1/cc-filters
integer:page=1#当前页码
integer:limit=10#单页显示数量
integer:internal_self#置为1时显示内置及自己的过滤器
integer:internal#置为1时,只显示内置过滤器
boolean:enable#显示禁用或启用的过滤器
<<<
返回结果
{
"code": 0,
"count": 1,
"data": [
{
"c.uid": 2,
"create_at": null,
"create_at2": "2021-11-25 14:36:29",
"des": "",
"enable": 1,
"extra": "{}",
"id": 10021,
"internal": 0,
"max_req": 5,
"max_req_per_uri": 0,
"name": "验证码",
"state": null,
"task_id": null,
"type": "captcha_filter",
"uid": 2,
"update_at": null,
"update_at2": "2021-11-25 14:36:29",
"username": "jason",
"version": 1,
"within_second": 60
}
]
}
~~~
## 新增过滤器
~~~[api]
post:/v1/cc-filters
*string:name#过滤器名称
des#备注
*type#类型,可选为req_rate、302_challenge、browser_verify_auto、slide_filter、captcha_filter、click_filter、url_auth、delay_jump_filter
*integer:within_second#在指定的秒数下统计
*integer:max_req#在within_second秒数内最大请求数
max_req_per_uri#统计同一个uri请求的次数。当类型为req_rate时,才需要填写。
json:extra#此字段为json类型,用于设置url鉴权。当类型为url_auth时才需要填写。当键值mode为TypeA时,需要提供key、sign_name、time_name、time_diff、sign_use_times;当mode为TypeB时,需要提供key、sign_name、time_diff、sign_use_times。key为密钥,sign_name为sign的参数数,time_name为time的参数名,time_diff为相当的时间,sign_use_times为签名可以用的次数。
<<<
返回结果
{
"code": 0,
"data": "1",
"msg": "过滤器添加成功"
}
<<<
提交内容
{
"name": "5秒验证",
"des": "",
"type": "delay_jump_filter",
"within_second": "60",
"max_req": "5",
"max_req_per_uri": "",
"extra": {}
}
~~~
## 批量修改过滤器 (数据格式为数组)
~~~[api]
put:/v1/cc-filters
integer:id#过滤器ID
string:name#过滤器名称
des#备注
type#类型,可选为req_rate、302_challenge、browser_verify_auto、slide_filter、captcha_filter、click_filter、url_auth、delay_jump_filter
integer:within_second#在指定的秒数下统计
integer:max_req#在within_second秒数内最大请求数
max_req_per_uri#统计同一个uri请求的次数。当类型为req_rate时,才需要填写。
json:extra#此字段为json类型,用于设置url鉴权。当类型为url_auth时才需要填写。当键值mode为TypeA时,需要提供key、sign_name、time_name、time_diff、sign_use_times;当mode为TypeB时,需要提供key、sign_name、time_diff、sign_use_times。key为密钥,sign_name为sign的参数数,time_name为time的参数名,time_diff为相当的时间,sign_use_times为签名可以用的次数。
<<<
返回结果
{
"code": 0,
"data": "",
"msg": "更新过滤器成功"
}
<<<
提交内容
[{
"id": 1,
"enable": 0
}, {
"id": 2,
"enable": 0
}]
~~~
## 获取单个过滤器
~~~[api]
get:/v1/cc-filters/<过滤器ID>
<<<
返回结果
{
"code": 0,
"data": {
"create_at": null,
"des": "",
"enable": 1,
"extra": "{}",
"id": 10021,
"internal": 0,
"max_req": 5,
"max_req_per_uri": 0,
"name": "验证码",
"task_id": null,
"type": "captcha_filter",
"uid": 2,
"update_at": null,
"version": 1,
"within_second": 60
},
"msg": ""
}
~~~
## 修改单个过滤器
~~~[api]
put:/v1/cc-filters/<过滤器ID>
string:name#过滤器名称
des#备注
type#类型,可选为req_rate、302_challenge、browser_verify_auto、slide_filter、captcha_filter、click_filter、url_auth、delay_jump_filter
integer:within_second#在指定的秒数下统计
integer:max_req#在within_second秒数内最大请求数
max_req_per_uri#统计同一个uri请求的次数。当类型为req_rate时,才需要填写。
json:extra#此字段为json类型,用于设置url鉴权。当类型为url_auth时才需要填写。当键值mode为TypeA时,需要提供key、sign_name、time_name、time_diff、sign_use_times;当mode为TypeB时,需要提供key、sign_name、time_diff、sign_use_times。key为密钥,sign_name为sign的参数数,time_name为time的参数名,time_diff为相当的时间,sign_use_times为签名可以用的次数。
<<<
返回结果
{
"code": 0,
"data": "",
"msg": "更新过滤器成功"
}
<<<
提交内容
{
"name": "新名称",
}
~~~
## 删除过滤器
~~~[api]
delete:/v1/cc-filters/<过滤器ID,多个以逗号分隔>
<<<
返回结果
{
"code": 0,
"data": "",
"msg": "过滤器删除成功"
}
~~~
- Cdnfly介绍
- 功能介绍
- 性能数据
- 安装说明
- 管理员文档
- 快速开始
- 节点管理
- DNS设置
- 线路分组
- CC参数配置
- 套餐管理
- 全局配置
- 充值设置
- 用户文档
- 网站管理
- 新增网站
- 网站编辑
- 缓存配置
- 刷新预热
- 证书管理
- CC规则
- ACL管理
- 四层转发
- 新增转发
- 转发编辑
- API文档
- 使用介绍
- 用户端
- 用户相关
- 帐号登录 /v1/login
- 重置用户密码 /v1/reset-pass
- 获取邮箱验证码 /v1/email-captcha
- 获取手机验证码 /v1/phone-captcha
- 获取、修改用户信息、注册用户 /v1/user
- 实名认证 /v1/user/certify
- 网站相关
- 网站管理 /v1/sites
- 网站分组 /v1/site-groups
- 网站证书 /v1/certs
- 申请证书的dnsapi /v1/dnsapis
- 网站ACL /v1/acls
- CC规则匹配器 /v1/cc-matchs
- CC规则过滤器 /v1/cc-filters
- CC规则组 /v1/cc-rules
- 网站任务(刷新预热、解锁、日志下载) /v1/jobs
- 四层相关
- 四层转发 /v1/streams
- 转发分组 /v1/stream-groups
- 套餐相关
- 在售套餐分组 /v1/package-groups
- 在售套餐 /v1/packages
- 在售升级包 /v1/package-ups
- 用户套餐 /v1/user-packages
- 用户套餐升级包 /v1/user-package/<package_id>/upgrades
- 套餐用量查询 /v1/user-package/<package_id>/usage
- 监控数据
- 网站实时统计 /v1/monitor/site/realtime
- 网站资源排行 /v1/monitor/site/top
- 网站黑名单 /v1/monitor/site/blackip
- 网站实时访问日志 /v1/monitor/site/access-log
- 用量查询 /v1/monitor/usage
- 转发实时统计 /v1/monitor/stream/realtime
- 转发资源排行 /v1/monitor/stream/top
- 消息相关
- 订阅消息 /v1/messages/sub
- 消息已读 /v1/messages/read
- 消息列表 /v1/messages
- 充值相关
- 微信充值 /v1/wxpay/preorder
- 支付宝充值 /v1/alipay/preorder
- 其它
- 订单查询 /v1/orders
- 获取系统配置 /v1/configs
- 登录日志 /v1/log/login
- 操作日志 /v1/log/op
- 用户端数据概览 /v1/user/overview
- api key管理 /v1/api-key
- 显示图片验证码 /v1/common/captcha
- 显示系统信息 /v1/common/sysinfo
- 注册信息 /v1/common/register-info
- 管理端
- 用户管理 /v1/users
- 用户充值 /v1/user/<用户ID>/recharge
- 区域管理 /v1/regions
- 节点管理 /v1/nodes
- 线路组管理 /v1/node-groups
- 线路管理 /v1/lines
- 基础套餐管理 /v1/packages
- 套餐组管理 /v1/package-groups
- 升级包管理 /v1/package-ups
- 用户套餐管理 /v1/user-packages
- api key管理 /v1/api-key
- FAQ