[TOC]
## 获取默认设置列表
~~~[api]
get:/v1/user-configs
integer:page=1#当前页码
integer:limit=10#单页显示数量
type#配置类别,可选为site, stream,cert,即网站,四层转发,证书
name#配置项,如proxy_cache,proxy_timeout等,即网站缓存,超时时间
boolean:enable#可选值为1和0,1为启用,0为禁用
<<<
返回结果
{
"code": 0,
"count": 2,
"data": [{
"create_at": "2023-06-01 16:00:12",
"enable": 1,
"id": 3,
"name": "proxy_cache",
"scope_id": 0,
"scope_name": "global",
"site_group_name": null,
"stream_group_name": null,
"type": "site",
"uid": 2,
"update_at": "2023-06-01 16:00:12",
"value": "[{\"type\":\"suffix\",\"content\":\"1\",\"expire\":\"1\",\"unit\":\"d\",\"ignore_arg\":false,\"range\":false,\"proxy_ignore_headers\":\"\",\"no_cache\":[]}]"
}, {
"create_at": "2023-06-01 15:37:54",
"enable": 1,
"id": 2,
"name": "extra_cc_rule",
"scope_id": 0,
"scope_name": "global",
"site_group_name": null,
"stream_group_name": null,
"type": "site",
"uid": 2,
"update_at": "2023-06-01 15:58:56",
"value": "[{\"matcher\":{\"ip\":{\"operator\":\"=\",\"value\":\"aa\"}},\"filter\":{\"within_second\":\"11\",\"max_challenge\":\"11111\",\"max_per_uri\":\"11111\",\"type\":\"click_filter\",\"extra\":{}}}]"
}]
}
~~~
## 添加默认设置
~~~[api]
post:/v1/user-configs
*type#配置类别,可选为site, stream,cert,即网站,四层转发,证书
*name#配置项,类别为site支持的配置项有proxy_cache(网站缓存),http_listen-port(http默认监听端口), https_listen-port(https默认监听端口), backend_http_port(默认回源http端口), backend_https_port(默认回源https端口),recv_real_time(实时接收),send_real_time(实时发送),https_listen-hsts(开启hsts), https_listen-http2(开启http2), https_listen-force_ssl_enable(强制https), ups_keepalive(启用回源连接池), range(分片回源), gzip_enable(启用gzip压缩), websocket_enable(开启websocket), block_proxy(屏蔽代理), https_listen-ocsp_stapling(开启oscp stapling),https_listen-ssl_protocols(ssl协议),https_listen-ssl_ciphers(ssl套件),https_listen-ssl_prefer_server_ciphers,backend_protocol(回源协议),proxy_timeout(回源超时),proxy_http_version(回源http版本),ups_keepalive_conn(连接池最大空闲数),ups_keepalive_timeout(空闲连接的超时时间),proxy_ssl_protocols(回源ssl协议),balance_way(负载方式),gzip_types(gzip压缩类型),post_size_limit(上传最大大小),cc_default_rule(默认cc规则),req_header(请求头),extra_cc_rule(自定义规则)
value#配置项的时,参数网站添加部分
scope_name#生效范围,可选为global, group,即全局和分组,默认全局
scope_id#可生效范围为group时,此值为分组的id
<<<
返回结果
{
"code":0,
"data": "1",
"msg": "用户配置添加成功"
}
<<<
提交内容
{
"type": "site",
"name": "proxy_timeout",
"value": "10"
}
~~~
## 修改一个默认设置
~~~[api]
put:/v1/user-configs/<默认设置ID>
*type#配置类别,可选为site, stream,cert,即网站,四层转发,证书
*name#配置项,类别为site支持的配置项有proxy_cache(网站缓存),http_listen-port(http默认监听端口), https_listen-port(https默认监听端口), backend_http_port(默认回源http端口), backend_https_port(默认回源https端口),recv_real_time(实时接收),send_real_time(实时发送),https_listen-hsts(开启hsts), https_listen-http2(开启http2), https_listen-force_ssl_enable(强制https), ups_keepalive(启用回源连接池), range(分片回源), gzip_enable(启用gzip压缩), websocket_enable(开启websocket), block_proxy(屏蔽代理), https_listen-ocsp_stapling(开启oscp stapling),https_listen-ssl_protocols(ssl协议),https_listen-ssl_ciphers(ssl套件),https_listen-ssl_prefer_server_ciphers,backend_protocol(回源协议),proxy_timeout(回源超时),proxy_http_version(回源http版本),ups_keepalive_conn(连接池最大空闲数),ups_keepalive_timeout(空闲连接的超时时间),proxy_ssl_protocols(回源ssl协议),balance_way(负载方式),gzip_types(gzip压缩类型),post_size_limit(上传最大大小),cc_default_rule(默认cc规则),req_header(请求头),extra_cc_rule(自定义规则)
value#配置项的时,参数网站添加部分
scope_name#生效范围,可选为global, group,即全局和分组,默认全局
scope_id#可生效范围为group时,此值为分组的id
boolean:enable#1为启用,0为禁用
<<<
返回结果
{
"code":0,
"data": "1",
"msg": "用户配置更新成功"
}
<<<
提交内容
{
"type": "site",
"name": "proxy_timeout",
"value": "10"
}
~~~
## 禁用或启用多个默认设置(数据类型为数组)
~~~[api]
put:/v1/user-configs
boolean:enable#1为启用,0为禁用
<<<
返回结果
{
"code":0,
"data": "1",
"msg": "用户配置更新成功"
}
<<<
提交内容
[{
"id": 3,
"enable": 0
}, {
"id": 2,
"enable": 0
}]
~~~
## 删除配置
~~~[api]
delete:/v1/user-configs/<配置ID,多个以逗号分隔>
<<<
返回结果
{
"code": 0,
"data": "",
"msg": "配置删除成功"
}
~~~
- Cdnfly介绍
- 功能介绍
- 性能数据
- 安装说明
- 管理员文档
- 快速开始
- 节点管理
- DNS设置
- 线路分组
- CC参数配置
- 套餐管理
- 全局配置
- 充值设置
- SMTP设置
- 用户文档
- 网站管理
- 新增网站
- 网站编辑
- 缓存配置
- 刷新预热
- 证书管理
- 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/user-configs
- 管理端
- 用户管理 /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