🔥码云GVP开源项目 12k star Uniapp+ElementUI 功能强大 支持多语言、二开方便! 广告
[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": "配置删除成功" } ~~~