{ "swagger": "2.0", "info": { "description": "SamWaf Web Application Firewall 开放平台 API 文档。需要在请求头携带 X-API-Key 进行鉴权。", "title": "SamWaf Open API", "contact": {}, "version": "1.0" }, "basePath": "/api/v1", "paths": { "/api/v1/owasp/audit_log": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "返回所有 override 操作的变更审计日志，按时间倒序排列（最新在前）", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "OWASP规则管理" ], "summary": "获取OWASP规则变更审计日志", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/api/v1/owasp/base_config": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "读取 Layer 1 基线配置（samwaf_base.json），包含偏执级别、异常分阈值等核心参数", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "OWASP规则管理" ], "summary": "获取OWASP基线配置", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "写入 Layer 1 基线配置并热重载；仅管理 CRS tx.* 数值变量，SecRuleEngine 和自定义变量不在此接口管理", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "OWASP规则管理" ], "summary": "更新OWASP基线配置", "parameters": [ { "description": "基线配置（blocking_paranoia_level、detection_paranoia_level、inbound_anomaly_score_threshold 等）", "name": "data", "in": "body", "required": true, "schema": { "type": "object" } } ], "responses": { "200": { "description": "Layer 1 基线已更新并热重载", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/api/v1/owasp/crs_var": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "新增或更新单个 CRS 事务变量（tx.*），保存后立即热重载 WAF 使其生效", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "OWASP规则管理" ], "summary": "设置单个CRS事务变量", "parameters": [ { "description": "CRS 变量键值", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafOwaspCRSVarSetReq" } } ], "responses": { "200": { "description": "CRS 变量已更新并热重载", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } }, "delete": { "security": [ { "ApiKeyAuth": [] } ], "description": "删除指定的 CRS 事务变量（tx.*），删除后立即热重载 WAF 使其生效", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "OWASP规则管理" ], "summary": "删除单个CRS事务变量", "parameters": [ { "type": "string", "description": "变量名（可带或不带 tx. 前缀）", "name": "key", "in": "query", "required": true } ], "responses": { "200": { "description": "CRS 变量已删除并热重载", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/api/v1/owasp/crs_vars": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "返回当前所有用户自定义的 CRS 事务变量（tx.*）键值列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "OWASP规则管理" ], "summary": "获取所有自定义CRS事务变量", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/api/v1/owasp/file_content": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "返回 data/owasp 目录下指定 .conf 文件的原始文本内容，路径不允许包含 .. 以防越界", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "OWASP规则管理" ], "summary": "获取OWASP规则文件原始内容", "parameters": [ { "type": "string", "description": "相对于 owasp 根目录的文件路径", "name": "path", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/api/v1/owasp/files": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "列出 data/owasp 目录下所有规则文件及其规则条数和最后修改时间（只读参考）", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "OWASP规则管理" ], "summary": "获取OWASP规则文件列表", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/api/v1/owasp/hit_stats": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "返回运行期间规则命中 Top-N 统计（内存数据，重启清零），支持按总次数、拦截次数、检测次数排序", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "OWASP规则管理" ], "summary": "获取OWASP规则命中统计", "parameters": [ { "type": "integer", "description": "最多返回条数，默认50，最大500", "name": "limit", "in": "query" }, { "type": "string", "description": "排序维度：all（默认，按总次数）/ blocked / detected", "name": "mode", "in": "query" } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/api/v1/owasp/hit_stats/reset": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "清空内存中所有规则的命中计数，重启后自动清零无需手动调用", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "OWASP规则管理" ], "summary": "清空OWASP规则命中统计", "responses": { "200": { "description": "命中统计已清空", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/api/v1/owasp/reload": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "清空规则扫描缓存并重新加载 WAF 配置，使所有 override 变更立即生效", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "OWASP规则管理" ], "summary": "手动触发WAF热重载", "responses": { "200": { "description": "reload 成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/api/v1/owasp/rule_detail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据规则 ID 返回规则原始内容及当前 override 状态（是否被改写/禁用及用户版本内容）", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "OWASP规则管理" ], "summary": "获取OWASP规则详情", "parameters": [ { "type": "integer", "description": "规则ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/api/v1/owasp/rule_override": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "用自定义内容覆盖指定规则，覆盖后立即热重载 WAF；原始规则内容哈希会被记录以便后续还原", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "OWASP规则管理" ], "summary": "改写OWASP规则内容", "parameters": [ { "description": "规则改写内容", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafOwaspRuleOverrideReq" } } ], "responses": { "200": { "description": "规则已改写并热重载", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/api/v1/owasp/rule_reset": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "删除指定规则的 override 记录，将其还原为 coreruleset 上游原始版本，并立即热重载 WAF", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "OWASP规则管理" ], "summary": "还原OWASP规则为上游版本", "parameters": [ { "description": "规则ID", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafOwaspRuleResetReq" } } ], "responses": { "200": { "description": "已还原并热重载", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/api/v1/owasp/rule_toggle": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "启用或禁用指定规则，操作后立即热重载 WAF 使其生效", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "OWASP规则管理" ], "summary": "启用/禁用OWASP规则", "parameters": [ { "description": "规则启用/禁用配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafOwaspRuleToggleReq" } } ], "responses": { "200": { "description": "已生效（已热重载 WAF）", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/api/v1/owasp/rules": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "扫描 coreruleset 目录，结合 overrides 注册表返回分页规则列表，支持按文件、严重级别、偏执级别、关键词、状态过滤", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "OWASP规则管理" ], "summary": "获取OWASP规则列表", "parameters": [ { "type": "string", "description": "文件名过滤（模糊匹配）", "name": "file", "in": "query" }, { "type": "string", "description": "严重级别过滤（CRITICAL/ERROR/WARNING/NOTICE）", "name": "severity", "in": "query" }, { "type": "integer", "description": "偏执级别过滤（1-4，0表示不过滤）", "name": "paranoia", "in": "query" }, { "type": "string", "description": "关键词搜索（匹配 msg、ID、文件名）", "name": "keyword", "in": "query" }, { "type": "string", "description": "状态过滤（disabled/modified/default，空表示全部）", "name": "status", "in": "query" }, { "type": "integer", "description": "页码，默认1", "name": "page_index", "in": "query" }, { "type": "integer", "description": "每页条数，默认50，最大500", "name": "page_size", "in": "query" } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/api/v1/owasp/test/dry_run": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "模拟一次 HTTP 请求，返回命中的规则列表、累计 anomaly 分值及是否被拦截，不影响真实流量", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "OWASP规则管理" ], "summary": "OWASP沙盒测试", "parameters": [ { "description": "模拟请求参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafOwaspDryRunReq" } } ], "responses": { "200": { "description": "测试完成", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/api/v1/owasp/tuning": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "读取当前 tuning 配置，包含规则引擎模式、偏执级别、异常分阈值等完整调参项", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "OWASP规则管理" ], "summary": "获取OWASP调参配置", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "写入 tuning 配置并热重载；同时兼容长名（inbound_anomaly_score_threshold）和短名（inbound_threshold）两套 key", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "OWASP规则管理" ], "summary": "更新OWASP调参配置", "parameters": [ { "description": "调参配置（rule_engine、blocking_paranoia_level、detection_paranoia_level、inbound_anomaly_score_threshold 等）", "name": "data", "in": "body", "required": true, "schema": { "type": "object" } } ], "responses": { "200": { "description": "已生效（已热重载）", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/api/v1/owasp/update/apply": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "后台异步执行规则库升级，接口立即返回；升级结果通过 WebSocket 消息推送给前端", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "OWASP规则管理" ], "summary": "执行OWASP规则库升级", "responses": { "200": { "description": "升级已触发，结果将通过后台消息推送", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/api/v1/owasp/update/check": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "查询远端规则库的最新版本信息并与本地版本对比，未配置远端时返回当前版本", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "OWASP规则管理" ], "summary": "检查OWASP规则库是否有新版本", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/api/v1/owasp/usage/doc": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "返回 OWASP 规则管理功能的 Markdown 格式使用说明文档", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "OWASP规则管理" ], "summary": "获取OWASP规则管理使用说明", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/diagnostic/cpuprofile/start": { "post": { "security": [ { "ApiKeyAuth": [] } ], "produces": [ "application/json" ], "tags": [ "运行诊断" ], "summary": "发起CPU采样", "responses": { "200": { "description": "已发起", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/diagnostic/cpuprofile/status": { "get": { "security": [ { "ApiKeyAuth": [] } ], "produces": [ "application/json" ], "tags": [ "运行诊断" ], "summary": "查询CPU采样状态", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/diagnostic/package": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "快照/趋势/goroutine dump/heap profile（及已完成的CPU采样）打包下载", "produces": [ "application/zip" ], "tags": [ "运行诊断" ], "summary": "下载运行诊断包", "responses": {} } }, "/diagnostic/snapshot": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "本进程视角的资源占用与内部组件计量，毫秒级采集", "produces": [ "application/json" ], "tags": [ "运行诊断" ], "summary": "获取运行诊断快照", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/diagnostic/trend": { "get": { "security": [ { "ApiKeyAuth": [] } ], "produces": [ "application/json" ], "tags": [ "运行诊断" ], "summary": "获取运行诊断趋势", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/firewall/ipblock/add": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "新增一条防火墙IP封禁规则（系统级别封禁，所有端口生效）", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "防火墙-IP封禁" ], "summary": "新增防火墙IP封禁", "parameters": [ { "description": "IP封禁配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafFirewallIPBlockAddReq" } } ], "responses": { "200": { "description": "添加成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/firewall/ipblock/capability": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "探测当前运行环境是否支持系统防火墙封禁（如容器内未安装 iptables 或缺少 NET_ADMIN 权限时不可用）", "produces": [ "application/json" ], "tags": [ "防火墙-IP封禁" ], "summary": "获取系统防火墙能力", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/firewall/ipblock/del": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID删除防火墙IP封禁规则，同步从系统防火墙解除封禁", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "防火墙-IP封禁" ], "summary": "删除防火墙IP封禁", "parameters": [ { "type": "string", "description": "封禁记录ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/firewall/ipblock/edit": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "修改防火墙IP封禁规则", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "防火墙-IP封禁" ], "summary": "编辑防火墙IP封禁", "parameters": [ { "description": "IP封禁配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafFirewallIPBlockEditReq" } } ], "responses": { "200": { "description": "编辑成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/firewall/ipblock/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "分页查询防火墙IP封禁规则列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "防火墙-IP封禁" ], "summary": "获取防火墙IP封禁列表", "parameters": [ { "description": "分页查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafFirewallIPBlockSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/hostconn/block": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "转调主机防爆破的手工封禁，走同一套账本与解封流程", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "远程连接看板" ], "summary": "封禁某个连接来源IP", "parameters": [ { "description": "封禁参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafHostGuardManualBanReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/hostconn/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "当前连接到本机的所有TCP连接，SSH/RDP 端口会被标记", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "远程连接看板" ], "summary": "远程连接列表", "parameters": [ { "description": "查询条件", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafHostConnSearchReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/hostconn/refresh": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "丢弃缓存立即重新采集（页面上的手工刷新按钮）", "produces": [ "application/json" ], "tags": [ "远程连接看板" ], "summary": "强制刷新连接快照", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/hostconn/summary": { "get": { "security": [ { "ApiKeyAuth": [] } ], "produces": [ "application/json" ], "tags": [ "远程连接看板" ], "summary": "远程连接汇总", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/hostguard/ban/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "主机防爆破" ], "summary": "主机防爆破封禁列表", "parameters": [ { "description": "查询条件", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafHostGuardBanSearchReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/hostguard/ban/manual": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "主机防爆破" ], "summary": "手工封禁一个IP", "parameters": [ { "description": "封禁参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafHostGuardManualBanReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/hostguard/ban/permanent": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "主机防爆破" ], "summary": "提升为永久封禁", "parameters": [ { "description": "封禁记录ID", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafHostGuardBanIdReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/hostguard/ban/release": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "主机防爆破" ], "summary": "提前解封", "parameters": [ { "description": "封禁记录ID", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafHostGuardBanIdReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/hostguard/event/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "主机防爆破" ], "summary": "主机登录失败事件列表", "parameters": [ { "description": "查询条件", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafHostGuardEventSearchReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/hostguard/ladder/list": { "get": { "security": [ { "ApiKeyAuth": [] } ], "produces": [ "application/json" ], "tags": [ "主机防爆破" ], "summary": "获取封禁阶梯配置", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/hostguard/ladder/save": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "整表替换，前端一次提交全部级别", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "主机防爆破" ], "summary": "保存封禁阶梯配置", "parameters": [ { "description": "阶梯列表", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafHostGuardLadderEditReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/hostguard/offender/del": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "主机防爆破" ], "summary": "删除攻击者档案", "parameters": [ { "description": "档案ID", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafHostGuardOffenderIdReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/hostguard/offender/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "主机防爆破" ], "summary": "攻击者档案列表", "parameters": [ { "description": "查询条件", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafHostGuardOffenderSearchReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/hostguard/offender/reset": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "重置后该IP下次被封从第1级重新开始", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "主机防爆破" ], "summary": "重置攻击者阶梯", "parameters": [ { "description": "档案ID", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafHostGuardOffenderIdReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/hostguard/statistics": { "get": { "security": [ { "ApiKeyAuth": [] } ], "produces": [ "application/json" ], "tags": [ "主机防爆破" ], "summary": "主机防爆破概览统计", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/hostguard/status": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "返回采集是否运行、事件源、工作模式、环境能力与降级原因", "produces": [ "application/json" ], "tags": [ "主机防爆破" ], "summary": "主机防爆破运行状态", "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/hostguard/whitelist/add": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "追加到白名单配置，并立即解除该IP当前的封禁", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "主机防爆破" ], "summary": "把IP加入白名单", "parameters": [ { "description": "IP", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafHostGuardWhitelistAddReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/hostguard/whitelist/test": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "输入一个IP，返回它会不会被豁免以及命中了哪一层白名单", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "主机防爆破" ], "summary": "白名单自测", "parameters": [ { "description": "待测IP", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafHostGuardWhitelistTestReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/logfilewrite/backupfiles": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "获取所有已归档的日志备份文件信息列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "日志文件写入" ], "summary": "获取日志备份文件列表", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/logfilewrite/clear": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "清空当前通知日志文件的所有内容", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "日志文件写入" ], "summary": "清空当前日志文件", "responses": { "200": { "description": "清空成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/logfilewrite/currentfile": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "获取当前通知日志文件的路径、大小等信息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "日志文件写入" ], "summary": "获取当前日志文件信息", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/logfilewrite/preview": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "获取通知日志文件最新 N 行内容，lines 范围 1-500，默认 100", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "日志文件写入" ], "summary": "获取日志文件预览", "parameters": [ { "type": "integer", "description": "行数（1-500，默认100）", "name": "lines", "in": "query" } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/logfilewrite/variables": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "获取日志文件写入模板中可用的所有变量名称及说明", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "日志文件写入" ], "summary": "获取日志模板变量列表", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/monitor/system_info": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "获取实时系统监控数据（CPU使用率、内存占用、网络流量等）", "produces": [ "application/json" ], "tags": [ "系统监控" ], "summary": "获取系统监控信息", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/notify/channel/add": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "新增一个通知渠道（支持企业微信、钉钉、Server酱等）", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知-渠道" ], "summary": "新增通知渠道", "parameters": [ { "description": "通知渠道配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafNotifyChannelAddReq" } } ], "responses": { "200": { "description": "添加成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/notify/channel/del": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID删除通知渠道", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知-渠道" ], "summary": "删除通知渠道", "parameters": [ { "type": "string", "description": "渠道ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/notify/channel/detail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID获取通知渠道详情", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知-渠道" ], "summary": "获取通知渠道详情", "parameters": [ { "type": "string", "description": "渠道ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/notify/channel/edit": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "修改通知渠道配置", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知-渠道" ], "summary": "编辑通知渠道", "parameters": [ { "description": "通知渠道配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafNotifyChannelEditReq" } } ], "responses": { "200": { "description": "编辑成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/notify/channel/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "分页查询通知渠道列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知-渠道" ], "summary": "获取通知渠道列表", "parameters": [ { "description": "分页查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafNotifyChannelSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/notify/globalthrottle": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "获取通知的全局默认频控参数，订阅未单独配置时继承这份", "produces": [ "application/json" ], "tags": [ "通知-订阅" ], "summary": "获取通知全局默认频率配置", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/notify/globalthrottle/update": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "更新全局默认频控参数，立即生效", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知-订阅" ], "summary": "更新通知全局默认频率配置", "parameters": [ { "description": "全局频控配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafNotifyGlobalThrottleUpdateReq" } } ], "responses": { "200": { "description": "更新成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/notify/log/del": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID删除指定通知日志记录", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知日志" ], "summary": "删除通知日志", "parameters": [ { "type": "string", "description": "日志ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/notify/log/detail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID获取单条通知日志详情", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知日志" ], "summary": "获取通知日志详情", "parameters": [ { "type": "string", "description": "日志ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/notify/log/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "分页查询通知发送日志列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知日志" ], "summary": "获取通知日志列表", "parameters": [ { "description": "分页查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafNotifyLogSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/notify/subscription/add": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "新增一条通知订阅，将事件类型与渠道关联", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知-订阅" ], "summary": "新增通知订阅", "parameters": [ { "description": "通知订阅配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafNotifySubscriptionAddReq" } } ], "responses": { "200": { "description": "添加成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/notify/subscription/batchconfig": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "把一份频控/模板/过滤配置套用到某类渠道的全部消息类型，或某个消息类型的全部渠道", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知-订阅" ], "summary": "批量套用通知订阅配置", "parameters": [ { "description": "批量配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafNotifySubscriptionBatchConfigReq" } } ], "responses": { "200": { "description": "套用成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/notify/subscription/config": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "为单个「消息类型 × 渠道」订阅配置频率控制、消息模板与过滤条件", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知-订阅" ], "summary": "保存通知订阅精细化配置", "parameters": [ { "description": "订阅配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafNotifySubscriptionConfigReq" } } ], "responses": { "200": { "description": "保存成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/notify/subscription/del": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID删除通知订阅", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知-订阅" ], "summary": "删除通知订阅", "parameters": [ { "type": "string", "description": "订阅ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/notify/subscription/dryrun": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "演算当前状态下一条事件会不会发出去、被什么挡住，不产生任何外发流量", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知-订阅" ], "summary": "通知订阅干跑演算", "parameters": [ { "description": "干跑参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafNotifySubscriptionDryRunReq" } } ], "responses": { "200": { "description": "演算成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/notify/subscription/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "分页查询通知订阅列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知-订阅" ], "summary": "获取通知订阅列表", "parameters": [ { "description": "分页查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafNotifySubscriptionSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/notify/subscription/preview": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "用样例数据渲染标题与正文，不发送任何通知", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知-订阅" ], "summary": "预览通知模板渲染结果", "parameters": [ { "description": "预览参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafNotifySubscriptionPreviewReq" } } ], "responses": { "200": { "description": "预览成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/notify/subscription/templatevars": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "返回指定消息类型可用的模板变量清单与内置默认模板示例", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知-订阅" ], "summary": "获取通知模板可用变量", "parameters": [ { "type": "string", "description": "消息类型", "name": "message_type", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/notify/subscription/test": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "用样例数据与当前模板真实发送一条通知，绕过频率控制与过滤条件", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "通知-订阅" ], "summary": "测试发送通知订阅", "parameters": [ { "description": "测试参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafNotifySubscriptionTestReq" } } ], "responses": { "200": { "description": "发送成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/resetWAF": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "重启WAF引擎，重新加载所有规则和配置", "produces": [ "application/json" ], "tags": [ "引擎-WAF引擎" ], "summary": "重启WAF引擎", "responses": { "200": { "description": "重启指令发起成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/sslconfig/add": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "上传并保存SSL证书（PEM格式的证书和私钥）", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SSL-证书配置" ], "summary": "新增SSL证书", "parameters": [ { "description": "SSL证书配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.SslConfigAddReq" } } ], "responses": { "200": { "description": "添加成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/sslconfig/del": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID删除SSL证书", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SSL-证书配置" ], "summary": "删除SSL证书", "parameters": [ { "type": "string", "description": "证书ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/sslconfig/detail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID获取SSL证书详情", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SSL-证书配置" ], "summary": "获取SSL证书详情", "parameters": [ { "type": "string", "description": "证书ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/sslconfig/edit": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "修改SSL证书内容", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SSL-证书配置" ], "summary": "编辑SSL证书", "parameters": [ { "description": "SSL证书配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.SslConfigEditReq" } } ], "responses": { "200": { "description": "编辑成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/sslconfig/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "分页查询SSL证书列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SSL-证书配置" ], "summary": "获取SSL证书列表", "parameters": [ { "description": "分页查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.SslConfigSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/statrumtimesysinfo": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "获取系统运行时信息（CPU、内存等）", "produces": [ "application/json" ], "tags": [ "统计-数据统计" ], "summary": "获取运行时系统基本信息", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/statsysinfo": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "获取首页显示的系统基本信息（版本、运行状态等）", "produces": [ "application/json" ], "tags": [ "统计-数据统计" ], "summary": "获取首页系统基本信息", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/sys_log/detail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID获取系统操作日志详情", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "系统日志" ], "summary": "获取系统日志详情", "parameters": [ { "type": "string", "description": "日志ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/sys_log/list": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "分页查询系统操作日志列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "系统日志" ], "summary": "获取系统日志列表", "parameters": [ { "description": "分页查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafSysLogSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/sysinfo/runtimeinfo": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "返回操作系统类型/发行版及版本、内核、容器(docker/k8s)、虚拟化、运行时长与软件版本，便于反馈问题时定位环境", "produces": [ "application/json" ], "tags": [ "系统信息" ], "summary": "获取系统运行环境信息", "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/model.RuntimeSystemInfo" } } } ] } } } } }, "/sysinfo/version": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "返回当前 SamWaf 的版本号、版本名称及发布状态", "produces": [ "application/json" ], "tags": [ "系统信息" ], "summary": "获取系统版本信息", "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/model.VersionInfo" } } } ] } } } } }, "/systemconfig/edit": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "修改系统配置项的值", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "系统配置" ], "summary": "更新系统配置", "parameters": [ { "description": "配置参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafSystemConfigEditReq" } } ], "responses": { "200": { "description": "编辑成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/systemconfig/editByItem": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "通过配置项的 item 键名修改对应的 value 值", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "系统配置" ], "summary": "通过item更新系统配置", "parameters": [ { "description": "配置参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafSystemConfigEditByItemReq" } } ], "responses": { "200": { "description": "编辑成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/systemconfig/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "分页查询系统配置项列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "系统配置" ], "summary": "获取系统配置列表", "parameters": [ { "description": "查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafSystemConfigSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/tunnel/tunnel/add": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "新增一个TCP/UDP端口转发隧道配置", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "隧道管理" ], "summary": "新增隧道配置", "parameters": [ { "description": "隧道配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafTunnelAddReq" } } ], "responses": { "200": { "description": "添加成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/tunnel/tunnel/connections": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "获取指定隧道的实时 TCP/UDP 连接数及来源 IP 列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "隧道管理" ], "summary": "获取隧道实时连接信息", "parameters": [ { "type": "string", "description": "隧道ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/tunnel/tunnel/del": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID删除隧道配置并关闭对应端口监听", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "隧道管理" ], "summary": "删除隧道配置", "parameters": [ { "type": "string", "description": "隧道ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/tunnel/tunnel/detail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID获取隧道配置详情", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "隧道管理" ], "summary": "获取隧道配置详情", "parameters": [ { "type": "string", "description": "隧道ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/tunnel/tunnel/edit": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "修改隧道配置并重新启动转发", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "隧道管理" ], "summary": "编辑隧道配置", "parameters": [ { "description": "隧道配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafTunnelEditReq" } } ], "responses": { "200": { "description": "编辑成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/tunnel/tunnel/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "分页查询隧道配置列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "隧道管理" ], "summary": "获取隧道配置列表", "parameters": [ { "description": "分页查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafTunnelSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/upgradenotice/ack": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "用户点「我知道了」后调用", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "升级须知" ], "summary": "升级须知标记已处理", "parameters": [ { "description": "条目ID", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafUpgradeNoticeIdReq" } } ], "responses": { "200": { "description": "操作成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/upgradenotice/downgradeack": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "用户点掉首页/列表页顶部的红色降级提示后调用；曾经运行过的最高版本再次变高时告警会重新出现", "produces": [ "application/json" ], "tags": [ "升级须知" ], "summary": "确认降级告警", "responses": { "200": { "description": "操作成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/upgradenotice/ignore": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "忽略后不再计入待处理，仍可在「全部」里查到", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "升级须知" ], "summary": "升级须知忽略", "parameters": [ { "description": "条目ID", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafUpgradeNoticeIdReq" } } ], "responses": { "200": { "description": "操作成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/upgradenotice/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "分页查询本次升级带来的须知事项，可按状态/类型/引入版本过滤", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "升级须知" ], "summary": "升级须知列表", "parameters": [ { "description": "查询条件", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafUpgradeNoticeSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/upgradenotice/popupshown": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "登录弹窗关闭后调用，此后不再弹（一辈子只弹一次）", "produces": [ "application/json" ], "tags": [ "升级须知" ], "summary": "升级须知弹窗已展示", "responses": { "200": { "description": "操作成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/upgradenotice/restore": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "把已处理/已忽略的条目退回待处理", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "升级须知" ], "summary": "升级须知恢复待处理", "parameters": [ { "description": "条目ID", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafUpgradeNoticeIdReq" } } ], "responses": { "200": { "description": "操作成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/upgradenotice/summary": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "首页顶部提示条与登录弹窗用：本次从哪个版本升到哪个版本、还有几项待处理、是否需要弹窗、是否处于降级运行", "produces": [ "application/json" ], "tags": [ "升级须知" ], "summary": "升级须知汇总", "parameters": [ { "type": "string", "description": "语言(zh_CN/en_US)，默认中文", "name": "lang", "in": "query" } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_response.UpgradeNoticeSummary" } } } ] } } } } }, "/vipconfig/getDomainWhitelist": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "获取当前管理端允许访问的域名白名单配置", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "管理端配置" ], "summary": "获取管理端域名白名单", "responses": { "200": { "description": "获取域名白名单成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/vipconfig/getIpWhitelist": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "获取当前管理端允许访问的IP白名单配置", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "管理端配置" ], "summary": "获取管理端IP白名单", "responses": { "200": { "description": "获取IP白名单成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/vipconfig/getManageTrustedProxies": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "获取当前管理端可信代理网段（CIDR/IP，逗号分隔）", "produces": [ "application/json" ], "tags": [ "管理端配置" ], "summary": "获取管理端可信代理网段", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/vipconfig/getNoticeTitle": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "获取当前通知消息的标题前缀，用于区分多个 SamWaf 实例", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "管理端配置" ], "summary": "获取通知标题前缀", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/vipconfig/getSecurityEntry": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "获取当前安全路径入口的启用状态及访问码", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "管理端配置" ], "summary": "获取安全路径入口配置", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/vipconfig/getSslBindCert": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "获取管理端证书当前绑定的证书夹ID及其摘要信息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "管理端配置" ], "summary": "获取管理端证书绑定的证书夹", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/vipconfig/getSslForceHttps": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "获取管理端是否仅允许HTTPS访问", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "管理端配置" ], "summary": "获取管理端仅允许HTTPS开关", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/vipconfig/getSslStatus": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "获取管理端SSL启用状态及证书信息（证书内容、域名、到期时间）", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "管理端配置" ], "summary": "获取管理端SSL状态", "responses": { "200": { "description": "获取SSL状态成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/vipconfig/manageClientIpProbe": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "回显本次请求的直连对端、可信代理判定、各代理头原始值与逐跳判定、最终采信的客户端IP及原因", "produces": [ "application/json" ], "tags": [ "管理端配置" ], "summary": "管理端真实IP诊断", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/vipconfig/restartManager": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "触发管理端1秒后重启，请等待5-10秒后重新访问", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "管理端配置" ], "summary": "重启管理端", "responses": { "200": { "description": "管理端将在1秒后重启", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/vipconfig/updateDomainWhitelist": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "更新管理端允许访问的域名白名单（多个域名用逗号分隔，为空表示不限制）", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "管理端配置" ], "summary": "更新管理端域名白名单", "parameters": [ { "description": "域名白名单配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafVpConfigDomainWhitelistUpdateReq" } } ], "responses": { "200": { "description": "更新域名白名单成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/vipconfig/updateIpWhitelist": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "更新管理端允许访问的IP白名单（CIDR格式，多个用逗号分隔）", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "管理端配置" ], "summary": "更新管理端IP白名单", "parameters": [ { "description": "IP白名单配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafVpConfigIpWhitelistUpdateReq" } } ], "responses": { "200": { "description": "更新IP白名单成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/vipconfig/updateManageTrustedProxies": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "仅当管理请求的直连对端落在此网段内，才采信代理头识别真实客户端；留空=不信任任何代理头。存 conf/config.yml，被白名单挡住时可改文件+重启自救", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "管理端配置" ], "summary": "更新管理端可信代理网段", "parameters": [ { "description": "可信代理网段配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafVpConfigManageTrustedProxiesUpdateReq" } } ], "responses": { "200": { "description": "更新成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/vipconfig/updateNoticeTitle": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "更新通知消息的标题前缀，立即生效无需重启，用于区分多个 SamWaf 实例", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "管理端配置" ], "summary": "更新通知标题前缀", "parameters": [ { "description": "通知标题配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafVpConfigNoticeTitleUpdateReq" } } ], "responses": { "200": { "description": "更新成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/vipconfig/updateSecurityEntry": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "开启/关闭安全路径入口，路径为空时自动生成18位随机码，立即生效无需重启", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "管理端配置" ], "summary": "更新安全路径入口配置", "parameters": [ { "description": "安全路径配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafVpConfigSecurityEntryUpdateReq" } } ], "responses": { "200": { "description": "更新成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/vipconfig/updateSslBindCert": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "把管理端证书绑定到指定证书夹条目；绑定后该证书夹经任一渠道更新时管理端证书会自动同步并重启。ssl_config_id 传空表示解绑（回到手动上传模式）。", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "管理端配置" ], "summary": "绑定/解绑管理端证书到证书夹", "parameters": [ { "description": "绑定配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafVpConfigSslBindCertUpdateReq" } } ], "responses": { "200": { "description": "更新成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/vipconfig/updateSslEnable": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "开启或关闭管理端HTTPS，修改后需重启管理端生效", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "管理端配置" ], "summary": "更新管理端SSL启用状态", "parameters": [ { "description": "SSL启用配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafVpConfigSslEnableUpdateReq" } } ], "responses": { "200": { "description": "更新SSL启用状态成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/vipconfig/updateSslForceHttps": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "开启后管理端纯HTTP请求将301跳转到HTTPS（仅在已启用SSL且证书有效时生效），需重启管理端生效", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "管理端配置" ], "summary": "更新管理端仅允许HTTPS开关", "parameters": [ { "description": "仅HTTPS配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafVpConfigSslForceHttpsUpdateReq" } } ], "responses": { "200": { "description": "更新成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/vipconfig/uploadSslCert": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "上传PEM格式的证书和私钥，校验通过后保存到 data/ssl/manager 目录，需重启生效", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "管理端配置" ], "summary": "上传管理端SSL证书", "parameters": [ { "description": "证书配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafVpConfigSslUploadReq" } } ], "responses": { "200": { "description": "上传SSL证书成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/accessaccount/add": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "新增一个统一访问认证的访客账号（密码 bcrypt 存储，不可读回）", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "统一访问认证-访问账号" ], "summary": "新增访问账号", "parameters": [ { "description": "账号信息", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafAccessAccountAddReq" } } ], "responses": { "200": { "description": "添加成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/accessaccount/del": { "get": { "security": [ { "ApiKeyAuth": [] } ], "produces": [ "application/json" ], "tags": [ "统一访问认证-访问账号" ], "summary": "删除访问账号", "parameters": [ { "type": "string", "description": "账号ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/accessaccount/detail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "produces": [ "application/json" ], "tags": [ "统一访问认证-访问账号" ], "summary": "获取访问账号详情", "parameters": [ { "type": "string", "description": "账号ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/accessaccount/edit": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "登录名不可修改（会话与审计以它关联）；改密请用 resetpwd 接口", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "统一访问认证-访问账号" ], "summary": "编辑访问账号", "parameters": [ { "description": "账号信息", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafAccessAccountEditReq" } } ], "responses": { "200": { "description": "编辑成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/accessaccount/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "统一访问认证-访问账号" ], "summary": "获取访问账号列表", "parameters": [ { "description": "分页查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafAccessAccountSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/wafhost/accessaccount/otp/bind": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "统一访问认证-访问账号" ], "summary": "绑定访问账号的二次验证", "parameters": [ { "description": "密钥与动态码", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafAccessAccountOtpBindReq" } } ], "responses": { "200": { "description": "绑定成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/accessaccount/otp/init": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "仅生成不落库，需调用 otp/bind 用一次正确动态码确认后才算绑定", "produces": [ "application/json" ], "tags": [ "统一访问认证-访问账号" ], "summary": "生成访问账号的二次验证密钥", "parameters": [ { "type": "string", "description": "账号ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "生成成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/accessaccount/otp/unbind": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "统一访问认证-访问账号" ], "summary": "解绑访问账号的二次验证", "parameters": [ { "description": "账号ID", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafAccessAccountOtpUnbindReq" } } ], "responses": { "200": { "description": "解绑成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/accessaccount/resetpwd": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "重置后该账号已有的在线会话会被立即踢下线", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "统一访问认证-访问账号" ], "summary": "重置访问账号密码", "parameters": [ { "description": "新密码", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafAccessAccountResetPwdReq" } } ], "responses": { "200": { "description": "重置成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/accessaudit/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "统一访问认证-审计" ], "summary": "获取统一访问认证审计日志", "parameters": [ { "description": "分页查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafAccessAuditSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/wafhost/accessconfig/detail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "密钥类字段不回显，仅返回 has_hmac_secret / has_service_token 两个标志位", "produces": [ "application/json" ], "tags": [ "统一访问认证-配置" ], "summary": "获取统一访问认证配置", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/accessconfig/hostoptions": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "由已配置且已启动的站点推导（排除全局网站与泛域名），供配置页下拉直接选用", "produces": [ "application/json" ], "tags": [ "统一访问认证-配置" ], "summary": "获取认证中心域名候选列表", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/accessconfig/regenerate_secret": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "会使所有在途的认证跳转失效（用户重跳一次即可），已登录会话不受影响", "produces": [ "application/json" ], "tags": [ "统一访问认证-配置" ], "summary": "轮换统一访问认证的签名密钥", "responses": { "200": { "description": "轮换成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/accessconfig/save": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "保存后立即发布运行时快照，所有站点同时生效", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "统一访问认证-配置" ], "summary": "保存统一访问认证配置", "parameters": [ { "description": "配置内容", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafAccessConfigSaveReq" } } ], "responses": { "200": { "description": "保存成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/accesssession/kick": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "被踢会话及其在各站点上的子令牌一并失效；因存在最长60秒的正向缓存，最迟60秒生效", "produces": [ "application/json" ], "tags": [ "统一访问认证-会话" ], "summary": "踢下线指定会话", "parameters": [ { "type": "string", "description": "会话ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "操作成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/accesssession/kickall": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "应急手段：疑似凭据泄露或策略配错时，一次性让所有人重新登录", "produces": [ "application/json" ], "tags": [ "统一访问认证-会话" ], "summary": "踢下线全部在线会话", "responses": { "200": { "description": "操作成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/accesssession/kickbyaccount": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "统一访问认证-会话" ], "summary": "踢下线指定账号的全部会话", "parameters": [ { "description": "账号ID", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafAccessSessionKickByAccountReq" } } ], "responses": { "200": { "description": "操作成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/accesssession/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "统一访问认证-会话" ], "summary": "获取统一访问认证的会话列表", "parameters": [ { "description": "分页查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafAccessSessionSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/wafhost/anticc/add": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "为指定网站新增一条CC防护规则（防止CC攻击）", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-CC防护" ], "summary": "新增CC防护规则", "parameters": [ { "description": "CC防护规则配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafAntiCCAddReq" } } ], "responses": { "200": { "description": "添加成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/anticc/del": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID删除CC防护规则", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-CC防护" ], "summary": "删除CC防护规则", "parameters": [ { "type": "string", "description": "规则ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/anticc/detail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID获取CC防护规则详情", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-CC防护" ], "summary": "获取CC防护规则详情", "parameters": [ { "type": "string", "description": "规则ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/anticc/edit": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "修改CC防护规则配置", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-CC防护" ], "summary": "编辑CC防护规则", "parameters": [ { "description": "CC防护规则配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafAntiCCEditReq" } } ], "responses": { "200": { "description": "编辑成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/anticc/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "分页查询CC防护规则列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-CC防护" ], "summary": "获取CC防护规则列表", "parameters": [ { "description": "分页查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafAntiCCSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/wafhost/cacherule/add": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "为指定网站新增一条缓存规则", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-缓存规则" ], "summary": "新增缓存规则", "parameters": [ { "description": "缓存规则配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafCacheRuleAddReq" } } ], "responses": { "200": { "description": "添加成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/cacherule/del": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID删除缓存规则", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-缓存规则" ], "summary": "删除缓存规则", "parameters": [ { "type": "string", "description": "规则ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/cacherule/detail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID获取缓存规则详情", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-缓存规则" ], "summary": "获取缓存规则详情", "parameters": [ { "type": "string", "description": "规则ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/cacherule/edit": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "修改缓存规则配置", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-缓存规则" ], "summary": "编辑缓存规则", "parameters": [ { "description": "缓存规则配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafCacheRuleEditReq" } } ], "responses": { "200": { "description": "编辑成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/cacherule/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "分页查询缓存规则列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-缓存规则" ], "summary": "获取缓存规则列表", "parameters": [ { "description": "分页查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafCacheRuleSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/wafhost/dataretention/detail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "数据保留策略" ], "summary": "获取数据保留策略详情", "parameters": [ { "type": "string", "description": "记录ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/dataretention/edit": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "数据保留策略" ], "summary": "编辑数据保留策略", "parameters": [ { "description": "策略参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafDataRetentionEditReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/dataretention/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "数据保留策略" ], "summary": "获取数据保留策略列表", "parameters": [ { "description": "分页参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafDataRetentionSearchReq" } } ], "responses": { "200": { "description": "OK", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/host/add": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "新增一个网站防护主机配置", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-主机管理" ], "summary": "新增网站防护主机", "parameters": [ { "description": "主机配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafHostAddReq" } } ], "responses": { "200": { "description": "添加成功，返回主机code", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "type": "string" } } } ] } } } } }, "/wafhost/host/checkports": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "校验端口监听表合法性并返回与其它站点的协议冲突明细（不落库）", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-主机管理" ], "summary": "预检端口监听表", "parameters": [ { "description": "预检参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafHostCheckPortsReq" } } ], "responses": { "200": { "description": "检测完成", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/host/del": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据 code 删除网站防护主机配置", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-主机管理" ], "summary": "删除网站防护主机", "parameters": [ { "type": "string", "description": "主机唯一编码", "name": "code", "in": "query", "required": true } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/host/detail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据 code 获取单个主机的详细配置", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-主机管理" ], "summary": "获取网站防护主机详情", "parameters": [ { "type": "string", "description": "主机唯一编码", "name": "code", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/model.Hosts" } } } ] } } } } }, "/wafhost/host/edit": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "修改网站防护主机配置信息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-主机管理" ], "summary": "编辑网站防护主机", "parameters": [ { "description": "主机配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafHostEditReq" } } ], "responses": { "200": { "description": "编辑成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/host/guardstatus": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "开启或关闭指定主机的WAF防御", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-主机管理" ], "summary": "修改主机防御状态", "parameters": [ { "type": "string", "description": "主机唯一编码", "name": "code", "in": "query", "required": true }, { "type": "integer", "description": "防御状态 1开启 0关闭", "name": "guard_status", "in": "query", "required": true } ], "responses": { "200": { "description": "状态更新成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/host/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "分页查询网站防护主机列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-主机管理" ], "summary": "获取网站防护主机列表", "parameters": [ { "description": "分页查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafHostSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/wafhost/host/startstatus": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "启动或停止指定主机的监听服务", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-主机管理" ], "summary": "修改主机启动状态", "parameters": [ { "type": "string", "description": "主机唯一编码", "name": "code", "in": "query", "required": true }, { "type": "integer", "description": "启动状态 1启动 0停止", "name": "start_status", "in": "query", "required": true } ], "responses": { "200": { "description": "状态更新成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/hostgroup/add": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "新增一个网站分组（仅用于管理端的组织与批量选择，不承载防护配置）", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-网站分组" ], "summary": "新增网站分组", "parameters": [ { "description": "分组信息", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafHostGroupAddReq" } } ], "responses": { "200": { "description": "添加成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/hostgroup/all": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "不分页，供网站列表左栏与网站表单下拉使用，额外带「未分组」与「全部」计数", "produces": [ "application/json" ], "tags": [ "网站防护-网站分组" ], "summary": "获取全部网站分组", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/hostgroup/assign": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "group_code 为空表示移出分组；全局网站不参与分组，会被自动剔除", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-网站分组" ], "summary": "批量移动网站到分组", "parameters": [ { "description": "网站与目标分组", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafHostGroupAssignReq" } } ], "responses": { "200": { "description": "移动成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/hostgroup/del": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "组内网站不会被删除，只是回落到「未分组」", "produces": [ "application/json" ], "tags": [ "网站防护-网站分组" ], "summary": "删除网站分组", "parameters": [ { "type": "string", "description": "记录ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/hostgroup/detail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "produces": [ "application/json" ], "tags": [ "网站防护-网站分组" ], "summary": "获取网站分组详情", "parameters": [ { "type": "string", "description": "记录ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/hostgroup/edit": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "只允许修改名称、颜色与备注，分组短码不可变", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-网站分组" ], "summary": "编辑网站分组", "parameters": [ { "description": "分组信息", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafHostGroupEditReq" } } ], "responses": { "200": { "description": "编辑成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/hostgroup/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "分页查询网站分组，含每组的网站数", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-网站分组" ], "summary": "获取网站分组列表", "parameters": [ { "description": "分页查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafHostGroupSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/wafhost/hostgroup/sort": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "提交完整的分组ID顺序，按数组下标写排序权重", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-网站分组" ], "summary": "网站分组排序", "parameters": [ { "description": "分组ID顺序", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafHostGroupSortReq" } } ], "responses": { "200": { "description": "排序成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/httpauthsession/kick": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "因存在最长60秒的正向缓存，最迟60秒生效；浏览器弹窗(Basic)方式下表现为强制重新输入一次密码", "produces": [ "application/json" ], "tags": [ "网站密码访问-会话" ], "summary": "踢下线指定会话", "parameters": [ { "type": "string", "description": "会话ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "操作成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/httpauthsession/kickall": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "应急手段：疑似密码泄露时，一次性让本站点所有人重新登录", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站密码访问-会话" ], "summary": "踢下线本站点的全部在线会话", "parameters": [ { "description": "站点编码", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafHttpAuthSessionKickAllReq" } } ], "responses": { "200": { "description": "操作成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/httpauthsession/kickbyuser": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站密码访问-会话" ], "summary": "踢下线指定用户在本站点的全部会话", "parameters": [ { "description": "站点编码与用户名", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafHttpAuthSessionKickByUserReq" } } ], "responses": { "200": { "description": "操作成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/httpauthsession/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站密码访问-会话" ], "summary": "获取网站密码访问的在线会话列表", "parameters": [ { "description": "分页查询参数，host_code 必填", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafHttpAuthSessionSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/wafhost/ip/lookup": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "查一个IP当前落在哪些名单里：IP黑/白名单、IP组、威胁情报IP、IP失败封禁、CC封禁、系统防火墙封禁、CDN回源段", "produces": [ "application/json" ], "tags": [ "网站防护-IP策略命中查询" ], "summary": "IP策略命中查询", "parameters": [ { "type": "string", "description": "待查询的IP", "name": "ip", "in": "query", "required": true }, { "type": "string", "description": "只查指定来源(逗号分隔)，留空查全部", "name": "sources", "in": "query" } ], "responses": { "200": { "description": "查询成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/ipblock/add": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "为指定网站新增一条IP黑名单记录", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-IP黑名单" ], "summary": "新增IP黑名单", "parameters": [ { "description": "IP黑名单配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafBlockIpAddReq" } } ], "responses": { "200": { "description": "添加成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/ipblock/del": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID删除IP黑名单记录", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-IP黑名单" ], "summary": "删除IP黑名单", "parameters": [ { "type": "string", "description": "记录ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/ipblock/detail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID获取IP黑名单记录详情", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-IP黑名单" ], "summary": "获取IP黑名单详情", "parameters": [ { "type": "string", "description": "记录ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/ipblock/edit": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "修改IP黑名单记录", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-IP黑名单" ], "summary": "编辑IP黑名单", "parameters": [ { "description": "IP黑名单配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafBlockIpEditReq" } } ], "responses": { "200": { "description": "编辑成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/ipblock/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "分页查询IP黑名单列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-IP黑名单" ], "summary": "获取IP黑名单列表", "parameters": [ { "description": "分页查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafBlockIpSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/wafhost/ipfailure/baniplist": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "获取当前因请求失败次数超限而被封禁的IP列表", "produces": [ "application/json" ], "tags": [ "网站防护-IP失败封禁" ], "summary": "获取IP失败封禁列表", "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/wafhost/ipfailure/config": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "获取IP失败封禁全局配置（启用状态、状态码、锁定时间等）", "produces": [ "application/json" ], "tags": [ "网站防护-IP失败封禁" ], "summary": "获取IP失败封禁配置", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } }, "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "更新IP失败封禁全局配置", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-IP失败封禁" ], "summary": "设置IP失败封禁配置", "parameters": [ { "description": "配置参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafIPFailureSetConfigReq" } } ], "responses": { "200": { "description": "设置成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/ipgroup/add": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "新增一个可跨站点复用的IP组", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-IP组" ], "summary": "新增IP组", "parameters": [ { "description": "IP组信息", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafIPGroupAddReq" } } ], "responses": { "200": { "description": "添加成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/ipgroup/del": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "默认拒绝删除被引用的组；force=1 时级联删除引用它的黑/白名单条目", "produces": [ "application/json" ], "tags": [ "网站防护-IP组" ], "summary": "删除IP组", "parameters": [ { "type": "string", "description": "记录ID", "name": "id", "in": "query", "required": true }, { "type": "integer", "description": "1=级联删除引用条目", "name": "force", "in": "query" } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/ipgroup/detail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "produces": [ "application/json" ], "tags": [ "网站防护-IP组" ], "summary": "获取IP组详情", "parameters": [ { "type": "string", "description": "记录ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/ipgroup/edit": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "只允许修改名称与备注；组短码创建后不可变(黑白名单与规则都在引用它)", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-IP组" ], "summary": "编辑IP组", "parameters": [ { "description": "IP组信息", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafIPGroupEditReq" } } ], "responses": { "200": { "description": "编辑成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/ipgroup/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "分页查询IP组列表，含每组的条目数", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-IP组" ], "summary": "获取IP组列表", "parameters": [ { "description": "分页查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafIPGroupSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/wafhost/ipgroup/options": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "返回全部IP组(不分页)，供黑/白名单表单选择引用", "produces": [ "application/json" ], "tags": [ "网站防护-IP组" ], "summary": "获取IP组下拉选项", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/ipgroup/refs": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "返回该组被多少条黑/白名单引用、涉及哪些站点，供删除前确认", "produces": [ "application/json" ], "tags": [ "网站防护-IP组" ], "summary": "查询IP组的引用情况", "parameters": [ { "type": "string", "description": "组短码", "name": "group_code", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/ipgroup/validate": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "校验单IP/CIDR/通配符/区间的写法是否合法，供前端即时反馈", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-IP组" ], "summary": "校验IP写法", "parameters": [ { "description": "待校验的IP", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafIPGroupValidateReq" } } ], "responses": { "200": { "description": "校验完成", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/ipgroupitem/add": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "向指定IP组添加一条IP(支持单IP/CIDR/通配符/区间)", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-IP组" ], "summary": "新增IP组条目", "parameters": [ { "description": "条目信息", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafIPGroupItemAddReq" } } ], "responses": { "200": { "description": "添加成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/ipgroupitem/batch/add": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "多行文本批量录入，每行一个IP；空行与#开头的注释行忽略，非法行不阻断其余行", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-IP组" ], "summary": "批量新增IP组条目", "parameters": [ { "description": "批量录入内容", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafIPGroupItemBatchAddReq" } } ], "responses": { "200": { "description": "添加完成", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/ipgroupitem/batch/del": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-IP组" ], "summary": "批量删除IP组条目", "parameters": [ { "description": "ID列表", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafIPGroupItemBatchDelReq" } } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/ipgroupitem/del": { "get": { "security": [ { "ApiKeyAuth": [] } ], "produces": [ "application/json" ], "tags": [ "网站防护-IP组" ], "summary": "删除IP组条目", "parameters": [ { "type": "string", "description": "记录ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/ipgroupitem/delall": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "清空指定IP组内的全部IP，组本身保留", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-IP组" ], "summary": "清空IP组条目", "parameters": [ { "description": "组短码", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafIPGroupItemDelAllReq" } } ], "responses": { "200": { "description": "清空成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/ipgroupitem/detail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "produces": [ "application/json" ], "tags": [ "网站防护-IP组" ], "summary": "获取IP组条目详情", "parameters": [ { "type": "string", "description": "记录ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/ipgroupitem/edit": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-IP组" ], "summary": "编辑IP组条目", "parameters": [ { "description": "条目信息", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafIPGroupItemEditReq" } } ], "responses": { "200": { "description": "编辑成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/ipgroupitem/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-IP组" ], "summary": "获取IP组条目列表", "parameters": [ { "description": "分页查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafIPGroupItemSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/wafhost/ipwhite/add": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "为指定网站新增一条IP白名单记录（白名单IP绕过WAF检测）", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-IP白名单" ], "summary": "新增IP白名单", "parameters": [ { "description": "IP白名单配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafAllowIpAddReq" } } ], "responses": { "200": { "description": "添加成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/ipwhite/del": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID删除IP白名单记录", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-IP白名单" ], "summary": "删除IP白名单", "parameters": [ { "type": "string", "description": "记录ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/ipwhite/detail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID获取IP白名单记录详情", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-IP白名单" ], "summary": "获取IP白名单详情", "parameters": [ { "type": "string", "description": "记录ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/ipwhite/edit": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "修改IP白名单记录", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-IP白名单" ], "summary": "编辑IP白名单", "parameters": [ { "description": "IP白名单配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafAllowIpEditReq" } } ], "responses": { "200": { "description": "编辑成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/ipwhite/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "分页查询IP白名单列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-IP白名单" ], "summary": "获取IP白名单列表", "parameters": [ { "description": "分页查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafAllowIpSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/wafhost/loadbalance/add": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "为指定网站新增一条后端负载均衡节点配置", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-负载均衡" ], "summary": "新增负载均衡节点", "parameters": [ { "description": "负载均衡节点配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafLoadBalanceAddReq" } } ], "responses": { "200": { "description": "添加成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/loadbalance/del": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID删除负载均衡后端节点", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-负载均衡" ], "summary": "删除负载均衡节点", "parameters": [ { "type": "string", "description": "节点ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/loadbalance/detail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID获取负载均衡节点配置详情", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-负载均衡" ], "summary": "获取负载均衡节点详情", "parameters": [ { "type": "string", "description": "节点ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/loadbalance/edit": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "修改负载均衡后端节点配置", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-负载均衡" ], "summary": "编辑负载均衡节点", "parameters": [ { "description": "负载均衡节点配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafLoadBalanceEditReq" } } ], "responses": { "200": { "description": "编辑成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/loadbalance/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "分页查询负载均衡节点列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-负载均衡" ], "summary": "获取负载均衡节点列表", "parameters": [ { "description": "分页查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafLoadBalanceSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/wafhost/onekeymod/del": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID删除一键修改历史记录", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "一键修改" ], "summary": "删除一键修改记录", "parameters": [ { "type": "string", "description": "记录ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/onekeymod/detail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID获取一键修改记录详情", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "一键修改" ], "summary": "获取一键修改记录详情", "parameters": [ { "type": "string", "description": "记录ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/onekeymod/doModify": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "对指定文件路径执行一键批量修改操作", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "一键修改" ], "summary": "执行一键修改", "parameters": [ { "description": "一键修改参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafDoOneKeyModReq" } } ], "responses": { "200": { "description": "修改成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/onekeymod/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "分页查询一键修改历史记录列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "一键修改" ], "summary": "获取一键修改记录列表", "parameters": [ { "description": "分页查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafOneKeyModSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/wafhost/onekeymod/parseNginx": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "解析粘贴文本或扫描宝塔vhost目录，提取待添加的被防护主机候选（只读，不修改文件）", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "一键修改" ], "summary": "解析nginx配置", "parameters": [ { "description": "解析参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafParseNginxReq" } } ], "responses": { "200": { "description": "解析成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/onekeymod/restore": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID还原指定的一键修改记录到原始状态", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "一键修改" ], "summary": "还原一键修改", "parameters": [ { "type": "string", "description": "记录ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "还原成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/port/overview": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "全机端口→协议→占用站点汇总，含冲突标记与当前实际监听状态", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-主机管理" ], "summary": "端口占用总览", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/privategroup/add": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "新增一个私有信息分组", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "私有分组管理" ], "summary": "新增私有分组", "parameters": [ { "description": "分组配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafPrivateGroupAddReq" } } ], "responses": { "200": { "description": "添加成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/privategroup/del": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID删除私有分组", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "私有分组管理" ], "summary": "删除私有分组", "parameters": [ { "type": "string", "description": "分组ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/privategroup/detail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID获取私有分组详情", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "私有分组管理" ], "summary": "获取私有分组详情", "parameters": [ { "type": "string", "description": "分组ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/privategroup/edit": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "修改私有分组信息", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "私有分组管理" ], "summary": "编辑私有分组", "parameters": [ { "description": "分组配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafPrivateGroupEditReq" } } ], "responses": { "200": { "description": "编辑成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/privategroup/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "分页查询私有分组列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "私有分组管理" ], "summary": "获取私有分组列表", "parameters": [ { "description": "分页查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafPrivateGroupSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/wafhost/privategroup/listbybelongcloud": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据所属云环境分页查询私有分组列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "私有分组管理" ], "summary": "按云环境查询私有分组列表", "parameters": [ { "description": "查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafPrivateGroupSearchByCloudReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/wafhost/privateinfo/add": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "新增一条私有配置信息（如 API Key、密码等敏感数据）", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "私有信息管理" ], "summary": "新增私有信息", "parameters": [ { "description": "私有信息配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafPrivateInfoAddReq" } } ], "responses": { "200": { "description": "添加成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/privateinfo/del": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID删除私有信息，同时清除对应的环境变量", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "私有信息管理" ], "summary": "删除私有信息", "parameters": [ { "type": "string", "description": "记录ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/privateinfo/detail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID获取私有信息详情，敏感值字段自动脱敏", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "私有信息管理" ], "summary": "获取私有信息详情", "parameters": [ { "type": "string", "description": "记录ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/privateinfo/edit": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "修改私有信息，若值为\"****\"则保留原值不更新", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "私有信息管理" ], "summary": "编辑私有信息", "parameters": [ { "description": "私有信息配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafPrivateInfoEditReq" } } ], "responses": { "200": { "description": "编辑成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/privateinfo/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "分页查询私有信息列表，敏感值字段自动脱敏", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "私有信息管理" ], "summary": "获取私有信息列表", "parameters": [ { "description": "分页查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafPrivateInfoSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/wafhost/rule/add": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "新增一条WAF防护规则", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-规则管理" ], "summary": "新增WAF规则", "parameters": [ { "description": "规则配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafRuleAddReq" } } ], "responses": { "200": { "description": "添加成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "type": "string" } } } ] } } } } }, "/wafhost/rule/del": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据 code 删除WAF防护规则", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-规则管理" ], "summary": "删除WAF规则", "parameters": [ { "type": "string", "description": "规则唯一编码", "name": "code", "in": "query", "required": true } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/rule/detail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据 code 获取单条WAF规则详情", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-规则管理" ], "summary": "获取WAF规则详情", "parameters": [ { "type": "string", "description": "规则唯一编码", "name": "code", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/model.Rules" } } } ] } } } } }, "/wafhost/rule/edit": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "修改已有WAF防护规则配置", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-规则管理" ], "summary": "编辑WAF规则", "parameters": [ { "description": "规则配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafRuleEditReq" } } ], "responses": { "200": { "description": "编辑成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/rule/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "分页查询WAF防护规则列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-规则管理" ], "summary": "获取WAF规则列表", "parameters": [ { "description": "分页查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafRuleSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/wafhost/rule/rulestatus": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "启用或禁用WAF防护规则", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-规则管理" ], "summary": "修改WAF规则状态", "parameters": [ { "type": "string", "description": "规则唯一编码", "name": "code", "in": "query", "required": true }, { "type": "integer", "description": "规则状态 1启用 0禁用", "name": "rule_status", "in": "query", "required": true } ], "responses": { "200": { "description": "状态更新成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/sensitive/add": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "新增一条敏感词记录（用于响应内容过滤和替换）", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-敏感词" ], "summary": "新增敏感词", "parameters": [ { "description": "敏感词配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafSensitiveAddReq" } } ], "responses": { "200": { "description": "添加成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/sensitive/del": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID删除敏感词记录", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-敏感词" ], "summary": "删除敏感词", "parameters": [ { "type": "string", "description": "记录ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/sensitive/detail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID获取敏感词记录详情", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-敏感词" ], "summary": "获取敏感词详情", "parameters": [ { "type": "string", "description": "记录ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/sensitive/edit": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "修改敏感词记录", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-敏感词" ], "summary": "编辑敏感词", "parameters": [ { "description": "敏感词配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafSensitiveEditReq" } } ], "responses": { "200": { "description": "编辑成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/sensitive/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "分页查询敏感词列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-敏感词" ], "summary": "获取敏感词列表", "parameters": [ { "description": "分页查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafSensitiveSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/wafhost/sslexpire/add": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "新增一个SSL证书到期监控配置", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SSL到期监控" ], "summary": "新增SSL到期监控", "parameters": [ { "description": "监控配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafSslExpireAddReq" } } ], "responses": { "200": { "description": "添加成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/sslexpire/del": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID删除SSL证书到期监控配置", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SSL到期监控" ], "summary": "删除SSL到期监控", "parameters": [ { "type": "string", "description": "记录ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/sslexpire/detail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID获取SSL证书到期监控详情", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SSL到期监控" ], "summary": "获取SSL到期监控详情", "parameters": [ { "type": "string", "description": "记录ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/sslexpire/edit": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "修改SSL证书到期监控配置", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SSL到期监控" ], "summary": "编辑SSL到期监控", "parameters": [ { "description": "监控配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafSslExpireEditReq" } } ], "responses": { "200": { "description": "编辑成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/sslexpire/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "分页查询SSL证书到期监控列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SSL到期监控" ], "summary": "获取SSL到期监控列表", "parameters": [ { "description": "分页查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafSslExpireSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/wafhost/sslexpire/nowcheck": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "立即触发一次SSL证书到期检测任务", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SSL到期监控" ], "summary": "立即检测SSL到期情况", "responses": { "200": { "description": "发起SSL检测任务成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/sslexpire/sync_host": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "将已配置的主机信息批量同步到SSL到期监控列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SSL到期监控" ], "summary": "同步主机信息到SSL监控", "responses": { "200": { "description": "发起同步任务成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/sslorder/add": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "向 Let's Encrypt 或 ZeroSSL 发起新的 SSL 证书申请", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SSL证书订单" ], "summary": "新建SSL证书申请订单", "parameters": [ { "description": "订单配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafSslorderaddReq" } } ], "responses": { "200": { "description": "添加成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/sslorder/del": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID删除SSL证书申请订单", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SSL证书订单" ], "summary": "删除SSL证书订单", "parameters": [ { "type": "string", "description": "订单ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/sslorder/detail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID获取SSL证书申请订单详情", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SSL证书订单" ], "summary": "获取SSL证书订单详情", "parameters": [ { "type": "string", "description": "订单ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/sslorder/edit": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "对已成功申请且未过期的证书发起续期申请", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SSL证书订单" ], "summary": "续期SSL证书订单", "parameters": [ { "description": "续期配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafSslordereditReq" } } ], "responses": { "200": { "description": "续期成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/sslorder/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "分页查询SSL证书申请订单列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "SSL证书订单" ], "summary": "获取SSL证书订单列表", "parameters": [ { "description": "分页查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafSslordersearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/wafhost/task/add": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "新增一个WAF定时任务配置", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "定时任务管理" ], "summary": "新增定时任务", "parameters": [ { "description": "任务配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafTaskAddReq" } } ], "responses": { "200": { "description": "添加成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/task/del": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID删除定时任务配置", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "定时任务管理" ], "summary": "删除定时任务", "parameters": [ { "type": "string", "description": "任务ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/task/detail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID获取定时任务详情", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "定时任务管理" ], "summary": "获取定时任务详情", "parameters": [ { "type": "string", "description": "任务ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/task/edit": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "修改定时任务配置并重新调度", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "定时任务管理" ], "summary": "编辑定时任务", "parameters": [ { "description": "任务配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafTaskEditReq" } } ], "responses": { "200": { "description": "编辑成功，任务已重新调度", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/task/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "分页查询定时任务列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "定时任务管理" ], "summary": "获取定时任务列表", "parameters": [ { "description": "分页查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafTaskSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/wafhost/task/log": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "读取指定任务方法的日志内容，支持增量加载（通过 offset 参数）", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "定时任务管理" ], "summary": "获取定时任务日志", "parameters": [ { "type": "string", "description": "任务方法名", "name": "task_method", "in": "query", "required": true }, { "type": "integer", "description": "最大行数（offset=0时生效，默认200，最大1000）", "name": "lines", "in": "query" }, { "type": "integer", "format": "int64", "description": "文件偏移量（0=从头读取，\u003e0=增量读取）", "name": "offset", "in": "query" } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/task/log/clear": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "清空指定任务方法的日志文件内容", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "定时任务管理" ], "summary": "清空定时任务日志", "parameters": [ { "type": "string", "description": "任务方法名", "name": "task_method", "in": "query", "required": true } ], "responses": { "200": { "description": "清空成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/task/manual_exec": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID立即手动触发执行一次定时任务", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "定时任务管理" ], "summary": "手动执行定时任务", "parameters": [ { "type": "string", "description": "任务ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "发起成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/urlblock/add": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "为指定网站新增一条URL黑名单记录（匹配该URL的请求将被拦截）", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-URL黑名单" ], "summary": "新增URL黑名单", "parameters": [ { "description": "URL黑名单配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafBlockUrlAddReq" } } ], "responses": { "200": { "description": "添加成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/urlblock/del": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID删除URL黑名单记录", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-URL黑名单" ], "summary": "删除URL黑名单", "parameters": [ { "type": "string", "description": "记录ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/urlblock/detail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID获取URL黑名单记录详情", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-URL黑名单" ], "summary": "获取URL黑名单详情", "parameters": [ { "type": "string", "description": "记录ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/urlblock/edit": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "修改URL黑名单记录", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-URL黑名单" ], "summary": "编辑URL黑名单", "parameters": [ { "description": "URL黑名单配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafBlockUrlEditReq" } } ], "responses": { "200": { "description": "编辑成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/urlblock/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "分页查询URL黑名单列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-URL黑名单" ], "summary": "获取URL黑名单列表", "parameters": [ { "description": "分页查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafBlockUrlSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/wafhost/urlwhite/add": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "为指定网站新增一条URL白名单记录（白名单URL绕过WAF检测）", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-URL白名单" ], "summary": "新增URL白名单", "parameters": [ { "description": "URL白名单配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafAllowUrlAddReq" } } ], "responses": { "200": { "description": "添加成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/urlwhite/del": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID删除URL白名单记录", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-URL白名单" ], "summary": "删除URL白名单", "parameters": [ { "type": "string", "description": "记录ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "删除成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/urlwhite/detail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据ID获取URL白名单记录详情", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-URL白名单" ], "summary": "获取URL白名单详情", "parameters": [ { "type": "string", "description": "记录ID", "name": "id", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/urlwhite/edit": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "修改URL白名单记录", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-URL白名单" ], "summary": "编辑URL白名单", "parameters": [ { "description": "URL白名单配置", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafAllowUrlEditReq" } } ], "responses": { "200": { "description": "编辑成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafhost/urlwhite/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "分页查询URL白名单列表", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "网站防护-URL白名单" ], "summary": "获取URL白名单列表", "parameters": [ { "description": "分页查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafAllowUrlSearchReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/waflog/attack/detail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "根据 req_uuid 获取单条攻击日志详情（含请求体、响应体）", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "日志-攻击日志" ], "summary": "获取攻击日志详情", "parameters": [ { "type": "string", "description": "请求UUID", "name": "req_uuid", "in": "query", "required": true }, { "type": "string", "description": "数据库名称，默认 local_log", "name": "current_db_name", "in": "query" }, { "type": "string", "description": "输出格式：raw 或 curl", "name": "output_format", "in": "query" } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/waflog/attack/list": { "post": { "security": [ { "ApiKeyAuth": [] } ], "description": "分页查询攻击日志，支持按主机码、规则、IP、时间范围等过滤", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "日志-攻击日志" ], "summary": "获取攻击日志列表", "parameters": [ { "description": "查询参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafAttackLogSearch" } } ], "responses": { "200": { "description": "获取成功", "schema": { "allOf": [ { "$ref": "#/definitions/SamWaf_model_common_response.Response" }, { "type": "object", "properties": { "data": { "$ref": "#/definitions/SamWaf_model_common_response.PageResult" } } } ] } } } } }, "/wafstatqpstrend": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "返回最近若干秒的QPS采样点（内存采样，不落库），用于首页QPS趋势图", "produces": [ "application/json" ], "tags": [ "统计-数据统计" ], "summary": "获取实时QPS趋势", "parameters": [ { "type": "integer", "description": "采样点个数(1-120，默认60)", "name": "limit", "in": "query" } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafstatsitedetail": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "查询指定站点的趋势数据（24h走小时聚合，7d/30d走天聚合），完全基于预聚合表", "produces": [ "application/json" ], "tags": [ "统计-数据统计" ], "summary": "站点详情趋势查询", "parameters": [ { "type": "string", "description": "网站唯一码", "name": "host_code", "in": "query", "required": true }, { "type": "string", "description": "时间范围: 24h | 7d | 30d", "name": "time_range", "in": "query", "required": true } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafstatsiteoverview": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "按日期范围查询各站点的综合访问数据（PV/UV/IP/流量/攻击），完全基于预聚合表", "produces": [ "application/json" ], "tags": [ "统计-数据统计" ], "summary": "站点综合概览统计", "parameters": [ { "type": "string", "description": "开始日期 如 20260301", "name": "start_day", "in": "query" }, { "type": "string", "description": "结束日期 如 20260310", "name": "end_day", "in": "query" } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafstatsumday": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "获取今日访问总量和拦截总量统计", "produces": [ "application/json" ], "tags": [ "统计-数据统计" ], "summary": "获取今日访问统计", "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafstatsumdayrange": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "按指定日期范围查询每日访问量和拦截量", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "统计-数据统计" ], "summary": "按日期范围统计访问量", "parameters": [ { "description": "日期范围参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafStatsDayRangeReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } }, "/wafstatsumdaytopiprange": { "get": { "security": [ { "ApiKeyAuth": [] } ], "description": "按日期范围统计攻击IP排行（Top N）", "consumes": [ "application/json" ], "produces": [ "application/json" ], "tags": [ "统计-数据统计" ], "summary": "统计攻击IP排行", "parameters": [ { "description": "日期范围参数", "name": "data", "in": "body", "required": true, "schema": { "$ref": "#/definitions/SamWaf_model_request.WafStatsDayRangeReq" } } ], "responses": { "200": { "description": "获取成功", "schema": { "$ref": "#/definitions/SamWaf_model_common_response.Response" } } } } } }, "definitions": { "SamWaf_model_common_response.PageResult": { "type": "object", "properties": { "list": {}, "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" }, "total": { "type": "integer" } } }, "SamWaf_model_common_response.Response": { "type": "object", "properties": { "code": { "type": "integer" }, "data": {}, "msg": { "type": "string" } } }, "SamWaf_model_request.SslConfigAddReq": { "type": "object", "properties": { "auto_load_path": { "description": "是否启用路径自动加载(1=开 0=关)，nil表示未提供按默认开", "type": "integer" }, "cert_content": { "description": "证书文件内容", "type": "string" }, "cert_path": { "description": "crt文件配置", "type": "string" }, "export_cert_path": { "description": "证书导出(落盘)：证书内容更新后同步写成实体文件，供外部程序使用，留空=不导出", "type": "string" }, "export_key_path": { "description": "导出key文件的完整路径", "type": "string" }, "key_content": { "description": "密钥文件内容", "type": "string" }, "key_path": { "description": "密钥文件位置", "type": "string" } } }, "SamWaf_model_request.SslConfigEditReq": { "type": "object", "properties": { "auto_load_path": { "description": "是否启用路径自动加载(1=开 0=关)，nil表示未提供保持原值", "type": "integer" }, "cert_content": { "description": "证书文件内容", "type": "string" }, "cert_path": { "description": "crt文件配置", "type": "string" }, "export_cert_path": { "description": "证书导出(落盘)：nil 表示旧前端未提供该字段，保持原值不动", "type": "string" }, "export_key_path": { "description": "导出key文件的完整路径", "type": "string" }, "id": { "type": "string" }, "key_content": { "description": "密钥文件内容", "type": "string" }, "key_path": { "description": "密钥文件位置", "type": "string" } } }, "SamWaf_model_request.SslConfigSearchReq": { "type": "object", "properties": { "domains": { "description": "证书适用的域名", "type": "string" }, "keyWord": { "description": "关键字", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" } } }, "SamWaf_model_request.WafAccessAccountAddReq": { "type": "object", "required": [ "account_name", "password" ], "properties": { "account_name": { "type": "string" }, "allow_host_codes": { "description": "换行分隔；空=全部站点", "type": "string" }, "expire_time": { "description": "yyyy-MM-dd HH:mm:ss，空=永不过期", "type": "string" }, "force_otp": { "description": "0继承全局 1强制 2豁免", "type": "integer" }, "nick_name": { "type": "string" }, "password": { "type": "string" }, "remarks": { "type": "string" }, "status": { "type": "integer" } } }, "SamWaf_model_request.WafAccessAccountEditReq": { "type": "object", "required": [ "id" ], "properties": { "allow_host_codes": { "type": "string" }, "expire_time": { "type": "string" }, "force_otp": { "type": "integer" }, "id": { "type": "string" }, "nick_name": { "type": "string" }, "remarks": { "type": "string" }, "status": { "type": "integer" } } }, "SamWaf_model_request.WafAccessAccountOtpBindReq": { "type": "object", "required": [ "code", "id", "secret" ], "properties": { "code": { "type": "string" }, "id": { "type": "string" }, "secret": { "type": "string" } } }, "SamWaf_model_request.WafAccessAccountOtpUnbindReq": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "SamWaf_model_request.WafAccessAccountResetPwdReq": { "type": "object", "required": [ "id", "password" ], "properties": { "id": { "type": "string" }, "password": { "type": "string" } } }, "SamWaf_model_request.WafAccessAccountSearchReq": { "type": "object", "properties": { "account_name": { "type": "string" }, "keyWord": { "description": "关键字", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" }, "status": { "description": "指针：不传=全部，传 0 才能查到已禁用账号", "type": "integer" } } }, "SamWaf_model_request.WafAccessAuditSearchReq": { "type": "object", "properties": { "account_name": { "type": "string" }, "category": { "description": "审计分类 access/config，空=全部", "type": "string" }, "client_ip": { "type": "string" }, "end_day": { "type": "integer" }, "event": { "type": "string" }, "host": { "type": "string" }, "keyWord": { "description": "关键字", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" }, "start_day": { "description": "20260801", "type": "integer" } } }, "SamWaf_model_request.WafAccessConfigSaveReq": { "type": "object", "properties": { "bind_fingerprint": { "type": "integer" }, "bind_ip": { "type": "integer" }, "bypass_ip_group_code": { "type": "string" }, "cache_positive_ttl_sec": { "type": "integer" }, "center_origin": { "description": "认证中心完整地址，必填", "type": "string" }, "cookie_prefix": { "type": "string" }, "cors_allow_headers": { "type": "string" }, "cors_allow_methods": { "type": "string" }, "cors_allow_origins": { "description": "跨源（CORS）。全空 = 不启用，站点级可按字段覆盖。", "type": "string" }, "cors_max_age": { "type": "integer" }, "force_secure_cookie": { "type": "integer" }, "global_exclude_paths": { "type": "string" }, "idle_timeout_minutes": { "type": "integer" }, "lock_minutes": { "type": "integer" }, "max_fail_count": { "type": "integer" }, "pass_identity_header": { "type": "integer" }, "path_prefix": { "type": "string" }, "require_otp": { "type": "integer" }, "service_token_header": { "type": "string" }, "service_tokens": { "description": "ServiceTokens 是明文服务令牌，后端只存 sha256。\n空字符串 = 保持原样不动；填 \"-\" = 清空。这样前端不必回显密文也能安全编辑。", "type": "string" }, "session_ttl_minutes": { "type": "integer" }, "ticket_ttl_seconds": { "type": "integer" }, "token_ttl_minutes": { "type": "integer" }, "unauth_action": { "type": "string" } } }, "SamWaf_model_request.WafAccessSessionKickByAccountReq": { "type": "object", "properties": { "account_id": { "type": "string" } } }, "SamWaf_model_request.WafAccessSessionSearchReq": { "type": "object", "properties": { "account_name": { "type": "string" }, "client_ip": { "type": "string" }, "keyWord": { "description": "关键字", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" }, "status": { "type": "integer" } } }, "SamWaf_model_request.WafAllowIpAddReq": { "type": "object", "required": [ "host_code" ], "properties": { "group_code": { "description": "IpType=group 时的IP组短码", "type": "string" }, "host_code": { "description": "网站唯一码（主要键）", "type": "string" }, "ip": { "description": "白名单ip：单IP / CIDR / 通配符(10.10.*.*) / 区间(起-止)", "type": "string" }, "ip_type": { "description": "条目类型: \"\"/ip(单条) | group(引用IP组)", "type": "string" }, "remarks": { "description": "备注", "type": "string" } } }, "SamWaf_model_request.WafAllowIpEditReq": { "type": "object", "required": [ "host_code", "id" ], "properties": { "group_code": { "description": "IpType=group 时的IP组短码", "type": "string" }, "host_code": { "description": "网站唯一码（主要键）", "type": "string" }, "id": { "description": "白名单IP唯一键", "type": "string" }, "ip": { "description": "白名单ip：单IP / CIDR / 通配符 / 区间", "type": "string" }, "ip_type": { "description": "条目类型: \"\"/ip(单条) | group(引用IP组)", "type": "string" }, "remarks": { "description": "备注", "type": "string" } } }, "SamWaf_model_request.WafAllowIpSearchReq": { "type": "object", "properties": { "group_code": { "description": "按引用的IP组筛选（Ip 是精确匹配，对组引用行永远查不到）", "type": "string" }, "host_code": { "description": "主机码", "type": "string" }, "ip": { "description": "白名单ip", "type": "string" }, "keyWord": { "description": "关键字", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" } } }, "SamWaf_model_request.WafAllowUrlAddReq": { "type": "object", "required": [ "compare_type", "host_code", "url" ], "properties": { "compare_type": { "description": "对比方式", "type": "string" }, "host_code": { "description": "网站唯一码（主要键）", "type": "string" }, "remarks": { "description": "备注", "type": "string" }, "url": { "description": "白名单url", "type": "string" } } }, "SamWaf_model_request.WafAllowUrlEditReq": { "type": "object", "required": [ "compare_type", "host_code", "id", "url" ], "properties": { "compare_type": { "description": "对比方式", "type": "string" }, "host_code": { "description": "网站唯一码（主要键）", "type": "string" }, "id": { "description": "白名单url唯一键", "type": "string" }, "remarks": { "description": "备注", "type": "string" }, "url": { "description": "白名单url", "type": "string" } } }, "SamWaf_model_request.WafAllowUrlSearchReq": { "type": "object", "properties": { "host_code": { "description": "主机码", "type": "string" }, "keyWord": { "description": "关键字", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" }, "url": { "description": "白名单url", "type": "string" } } }, "SamWaf_model_request.WafAntiCCAddReq": { "type": "object", "required": [ "host_code", "limit", "limit_mode", "lock_ip_minutes", "rate" ], "properties": { "host_code": { "description": "网站唯一码（主要键）", "type": "string" }, "is_enable_rule": { "description": "是否启动规则", "type": "boolean" }, "limit": { "description": "限制", "type": "integer" }, "limit_mode": { "description": "\"rate\" 或 \"window\"", "type": "string" }, "lock_ip_minutes": { "description": "封禁分钟", "type": "integer" }, "rate": { "description": "速率", "type": "integer" }, "remarks": { "description": "备注", "type": "string" }, "rule_content": { "description": "规则内容", "type": "string" }, "skip_global_cc": { "description": "命中局部CC规则后跳过全局CC检测", "type": "boolean" }, "url": { "description": "废弃", "type": "string" } } }, "SamWaf_model_request.WafAntiCCEditReq": { "type": "object", "required": [ "host_code", "id", "limit", "limit_mode", "lock_ip_minutes", "rate" ], "properties": { "host_code": { "description": "网站唯一码（主要键）", "type": "string" }, "id": { "description": "Anti CC唯一键", "type": "string" }, "is_enable_rule": { "description": "是否启动规则", "type": "boolean" }, "limit": { "description": "限制", "type": "integer" }, "limit_mode": { "description": "\"rate\" 或 \"window\"", "type": "string" }, "lock_ip_minutes": { "description": "封禁分钟", "type": "integer" }, "rate": { "description": "速率", "type": "integer" }, "remarks": { "description": "备注", "type": "string" }, "rule_content": { "description": "规则内容", "type": "string" }, "skip_global_cc": { "description": "命中局部CC规则后跳过全局CC检测", "type": "boolean" }, "url": { "description": "废弃", "type": "string" } } }, "SamWaf_model_request.WafAntiCCSearchReq": { "type": "object", "properties": { "host_code": { "description": "主机码", "type": "string" }, "keyWord": { "description": "关键字", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" } } }, "SamWaf_model_request.WafAttackLogSearch": { "type": "object", "properties": { "action": { "description": "状态", "type": "string" }, "current_db_name": { "type": "string" }, "filter_by": { "description": "筛选字段", "type": "string" }, "filter_value": { "description": "筛选值", "type": "string" }, "host_code": { "description": "主机码", "type": "string" }, "keyWord": { "description": "关键字", "type": "string" }, "log_only_mode": { "description": "日志模式", "type": "string" }, "method": { "description": "访问方法", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" }, "req_uuid": { "description": "请求UUID", "type": "string", "maxLength": 64 }, "rule": { "description": "规则名", "type": "string" }, "sort_by": { "description": "排序字段", "type": "string" }, "sort_descending": { "description": "排序方式", "type": "string" }, "src_ip": { "description": "请求IP", "type": "string" }, "status_code": { "description": "响应码", "type": "string" }, "unix_add_time_begin": { "description": "开始时间", "type": "string" }, "unix_add_time_end": { "description": "结束时间", "type": "string" }, "view_type": { "description": "视图：access=访问日志(默认) event=安全事件", "type": "string" } } }, "SamWaf_model_request.WafBlockIpAddReq": { "type": "object", "required": [ "host_code" ], "properties": { "group_code": { "description": "IpType=group 时的IP组短码", "type": "string" }, "host_code": { "description": "网站唯一码（主要键）", "type": "string" }, "ip": { "description": "Block ip：单IP / CIDR / 通配符(10.10.*.*) / 区间(起-止)", "type": "string" }, "ip_type": { "description": "条目类型: \"\"/ip(单条) | group(引用IP组)", "type": "string" }, "remarks": { "description": "备注", "type": "string" }, "target_layer": { "description": "封禁层级: \"\"/waf(WAF应用层) | system(系统防火墙) | both(两者)", "type": "string" } } }, "SamWaf_model_request.WafBlockIpEditReq": { "type": "object", "required": [ "host_code", "id" ], "properties": { "group_code": { "description": "IpType=group 时的IP组短码", "type": "string" }, "host_code": { "description": "网站唯一码（主要键）", "type": "string" }, "id": { "description": "Block IP唯一键", "type": "string" }, "ip": { "description": "Block ip：单IP / CIDR / 通配符 / 区间", "type": "string" }, "ip_type": { "description": "条目类型: \"\"/ip(单条) | group(引用IP组)", "type": "string" }, "remarks": { "description": "备注", "type": "string" } } }, "SamWaf_model_request.WafBlockIpSearchReq": { "type": "object", "properties": { "group_code": { "description": "按引用的IP组筛选（Ip 是精确匹配，对组引用行永远查不到）", "type": "string" }, "host_code": { "description": "主机码", "type": "string" }, "ip": { "description": "Block ip", "type": "string" }, "keyWord": { "description": "关键字", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" } } }, "SamWaf_model_request.WafBlockUrlAddReq": { "type": "object", "required": [ "compare_type", "host_code", "url" ], "properties": { "compare_type": { "description": "对比方式", "type": "string" }, "host_code": { "description": "网站唯一码（主要键）", "type": "string" }, "remarks": { "description": "备注", "type": "string" }, "url": { "description": "Block url", "type": "string" } } }, "SamWaf_model_request.WafBlockUrlEditReq": { "type": "object", "required": [ "compare_type", "host_code", "id", "url" ], "properties": { "compare_type": { "description": "对比方式", "type": "string" }, "host_code": { "description": "网站唯一码（主要键）", "type": "string" }, "id": { "description": "Block url唯一键", "type": "string" }, "remarks": { "description": "备注", "type": "string" }, "url": { "description": "Block url", "type": "string" } } }, "SamWaf_model_request.WafBlockUrlSearchReq": { "type": "object", "properties": { "host_code": { "description": "主机码", "type": "string" }, "keyWord": { "description": "关键字", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" }, "url": { "description": "Block url", "type": "string" } } }, "SamWaf_model_request.WafCacheRuleAddReq": { "type": "object", "properties": { "cache_time": { "type": "integer" }, "host_code": { "type": "string" }, "param_type": { "type": "integer" }, "priority": { "type": "integer" }, "remarks": { "type": "string" }, "request_method": { "type": "string" }, "rule_content": { "type": "string" }, "rule_name": { "type": "string" }, "rule_type": { "type": "integer" } } }, "SamWaf_model_request.WafCacheRuleEditReq": { "type": "object", "properties": { "cache_time": { "type": "integer" }, "host_code": { "type": "string" }, "id": { "type": "string" }, "param_type": { "type": "integer" }, "priority": { "type": "integer" }, "remarks": { "type": "string" }, "request_method": { "type": "string" }, "rule_content": { "type": "string" }, "rule_name": { "type": "string" }, "rule_type": { "type": "integer" } } }, "SamWaf_model_request.WafCacheRuleSearchReq": { "type": "object", "properties": { "host_code": { "type": "string" }, "keyWord": { "description": "关键字", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" } } }, "SamWaf_model_request.WafDataRetentionEditReq": { "type": "object", "properties": { "clean_enabled": { "type": "integer" }, "id": { "type": "string" }, "remarks": { "type": "string" }, "retain_days": { "type": "integer" }, "retain_rows": { "type": "integer" } } }, "SamWaf_model_request.WafDataRetentionSearchReq": { "type": "object", "properties": { "keyWord": { "description": "关键字", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" } } }, "SamWaf_model_request.WafDoOneKeyModReq": { "type": "object", "properties": { "file_path": { "description": "文件所在路径", "type": "string" } } }, "SamWaf_model_request.WafFirewallIPBlockAddReq": { "type": "object", "required": [ "ip" ], "properties": { "block_type": { "description": "封禁类型：manual-手动封禁, auto-自动封禁, temp-临时封禁", "type": "string" }, "expire_time": { "description": "过期时间（时间戳，0表示永久）", "type": "integer" }, "host_code": { "description": "网站唯一码（主要键）", "type": "string" }, "ip": { "description": "被封禁的IP地址", "type": "string" }, "reason": { "description": "封禁原因", "type": "string" }, "remarks": { "description": "备注", "type": "string" } } }, "SamWaf_model_request.WafFirewallIPBlockEditReq": { "type": "object", "required": [ "id", "ip" ], "properties": { "block_type": { "description": "封禁类型", "type": "string" }, "expire_time": { "description": "过期时间（时间戳，0表示永久）", "type": "integer" }, "host_code": { "description": "网站唯一码（主要键）", "type": "string" }, "id": { "description": "唯一键", "type": "string" }, "ip": { "description": "被封禁的IP地址", "type": "string" }, "reason": { "description": "封禁原因", "type": "string" }, "remarks": { "description": "备注", "type": "string" }, "status": { "description": "状态", "type": "string" } } }, "SamWaf_model_request.WafFirewallIPBlockSearchReq": { "type": "object", "properties": { "block_type": { "description": "封禁类型", "type": "string" }, "host_code": { "description": "主机码", "type": "string" }, "ip": { "description": "IP地址", "type": "string" }, "keyWord": { "description": "关键字", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" }, "reason": { "description": "封禁原因", "type": "string" }, "status": { "description": "状态", "type": "string" } } }, "SamWaf_model_request.WafHostAddReq": { "type": "object", "properties": { "access_json": { "description": "统一访问认证(Access模式)站点级配置 json", "type": "string" }, "anti_leech_json": { "description": "防盗链配置 json", "type": "string" }, "auto_jump_https": { "description": "是否自动跳转https 0 不自动 1 强制80跳转https", "type": "integer" }, "bind_more_host": { "description": "绑定多域名", "type": "string" }, "bind_more_port": { "description": "是否绑定多个端口", "type": "string" }, "bind_ssl_id": { "description": "绑定SSL的ID", "type": "string" }, "cache_json": { "description": "缓存配置 json", "type": "string" }, "captcha_json": { "description": "验证码配置 json", "type": "string" }, "cdn_provider": { "description": "cdn_preset 模式选择的 CDN 厂商码", "type": "string" }, "certfile": { "description": "证书文件", "type": "string" }, "code": { "description": "唯一编码", "type": "string" }, "cookie_security_json": { "description": "Cookie安全保护配置 json", "type": "string" }, "csrf_json": { "description": "CSRF防护配置 json", "type": "string" }, "custom_headers_json": { "description": "自定义头信息配置 json", "type": "string" }, "custom_response_headers_json": { "description": "自定义响应头信息配置 json", "type": "string" }, "default_encoding": { "description": "默认编码 utf-8 或者 gbk auto字符串自动选择", "type": "string" }, "defense_json": { "description": "自身防御 json", "type": "string" }, "disable_http2": { "description": "对外HTTP/2开关 0启用 1关闭(该站点只走http/1.1,兼容原生WebSocket客户端)", "type": "integer" }, "exclude_ip_log": { "description": "排除记录日志的IP清单 换行或逗号隔开：单IP/CIDR/通配符/区间/group:组短码", "type": "string" }, "exclude_url_log": { "description": "排除的url开头的数据 换行隔开", "type": "string" }, "group_code": { "description": "所属分组短码，空=未分组（纯管理端组织维度，不下发引擎）", "type": "string" }, "healthy_json": { "description": "后端健康度检测 json", "type": "string" }, "host": { "description": "域名", "type": "string" }, "http_auth_base_type": { "description": "认证类型 authorization(默认Basic Auth) custom(自定义页面)", "type": "string" }, "http_auth_json": { "description": "网站密码访问的会话时效配置 json", "type": "string" }, "http_auth_path_prefix": { "description": "HTTP认证路径前缀，用于隐藏系统特征，默认为随机生成", "type": "string" }, "insecure_skip_verify": { "description": "是否开启后端https证书有效性验证 默认 0 是校验 1 是不校验", "type": "integer" }, "ip_mode": { "description": "IP提取模式: \"nic\" 网卡模式 或 \"proxy\" 代理模式", "type": "string" }, "ip_real_header": { "description": "header/cdn_preset 模式指定的真实IP头，如 CF-Connecting-IP", "type": "string" }, "ip_source_mode": { "description": "真实IP来源模式: \"\"(兼容,取XFF最左) | nic | header | xff_depth | cdn_preset", "type": "string" }, "ip_trust_depth": { "description": "xff_depth 模式：从右往左取第 N 个 hop(默认1)", "type": "integer" }, "ip_trust_proxies": { "description": "可信代理网段(CIDR/IP，逗号分隔)，用于校验真实IP头来源", "type": "string" }, "is_enable_http_auth_base": { "description": "是否 HTTPAuthBase 1 激活 非1 没有激活", "type": "integer" }, "is_enable_load_balance": { "description": "是否激活负载 1 激活 非1 没有激活", "type": "integer" }, "is_enable_response_buffering": { "description": "响应缓冲 1开启(默认) 0关闭(类似 nginx proxy_buffering off)", "type": "integer" }, "is_trans_back_domain": { "description": "是否传递后端域名到后端服务器侧", "type": "integer" }, "keyfile": { "description": "密钥文件", "type": "string" }, "load_balance_stage": { "description": "负载策略", "type": "integer" }, "log_only_mode": { "description": "是否只记录日志 1 是 0 不是", "type": "integer" }, "nickname": { "description": "网站昵称", "type": "string" }, "port": { "description": "端口", "type": "integer" }, "port_listens_json": { "description": "端口监听表(JSON)，空=按老规则派生", "type": "string" }, "remarks": { "description": "备注", "type": "string" }, "remote_app": { "description": "是什么类型的应用", "type": "string" }, "remote_host": { "description": "远端域名", "type": "string" }, "remote_ip": { "description": "远端指定IP", "type": "string" }, "remote_port": { "description": "远端端口", "type": "integer" }, "remote_system": { "description": "是宝塔 phpstudy等", "type": "string" }, "response_compress_json": { "description": "响应压缩配置 json", "type": "string" }, "response_time_out": { "description": "响应超时时间", "type": "integer" }, "ssl": { "description": "是否是ssl", "type": "integer" }, "start_status": { "description": "启动状态", "type": "integer" }, "static_site_json": { "description": "静态站点配置 json", "type": "string" }, "tamper_json": { "description": "网页防篡改配置 json", "type": "string" }, "transport_json": { "description": "Transport配置 json", "type": "string" }, "unrestricted_port": { "description": "不限来源匹配端口 0 限制 1，不限制", "type": "integer" }, "upload_security_json": { "description": "文件上传内容检测配置 json", "type": "string" } } }, "SamWaf_model_request.WafHostCheckPortsReq": { "type": "object", "properties": { "auto_jump_https": { "type": "integer" }, "code": { "type": "string" }, "port": { "type": "integer" }, "port_listens_json": { "type": "string" }, "ssl": { "type": "integer" } } }, "SamWaf_model_request.WafHostConnSearchReq": { "type": "object", "properties": { "local_port": { "description": "按本机监听端口筛选，0=不限", "type": "integer" }, "only_guard": { "description": "1=只看 SSH/RDP 端口", "type": "integer" }, "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" }, "remote_ip": { "description": "源IP模糊匹配", "type": "string" }, "state": { "description": "ESTABLISHED / LISTEN / ...，留空=不限", "type": "string" } } }, "SamWaf_model_request.WafHostEditReq": { "type": "object", "properties": { "access_json": { "description": "统一访问认证(Access模式)站点级配置 json", "type": "string" }, "anti_leech_json": { "description": "防盗链配置 json", "type": "string" }, "auto_jump_https": { "description": "是否自动跳转https 0 不自动 1 强制80跳转https", "type": "integer" }, "bind_more_host": { "description": "绑定多域名", "type": "string" }, "bind_more_port": { "description": "是否绑定多个端口", "type": "string" }, "bind_ssl_id": { "description": "绑定SSL的ID", "type": "string" }, "cache_json": { "description": "缓存配置 json", "type": "string" }, "captcha_json": { "description": "验证码配置 json", "type": "string" }, "cdn_provider": { "description": "cdn_preset 模式选择的 CDN 厂商码", "type": "string" }, "certfile": { "description": "证书文件", "type": "string" }, "code": { "type": "string" }, "cookie_security_json": { "description": "Cookie安全保护配置 json", "type": "string" }, "csrf_json": { "description": "CSRF防护配置 json", "type": "string" }, "custom_headers_json": { "description": "自定义头信息配置 json", "type": "string" }, "custom_response_headers_json": { "description": "自定义响应头信息配置 json", "type": "string" }, "default_encoding": { "description": "默认编码 utf-8 或者 gbk auto字符串自动选择", "type": "string" }, "defense_json": { "description": "自身防御 json", "type": "string" }, "disable_http2": { "description": "对外HTTP/2开关 0启用 1关闭(该站点只走http/1.1,兼容原生WebSocket客户端)", "type": "integer" }, "exclude_ip_log": { "description": "排除记录日志的IP清单 换行或逗号隔开：单IP/CIDR/通配符/区间/group:组短码", "type": "string" }, "exclude_url_log": { "description": "排除的url开头的数据 换行隔开", "type": "string" }, "group_code": { "description": "所属分组短码，空=未分组（纯管理端组织维度，不下发引擎）", "type": "string" }, "healthy_json": { "description": "后端健康度检测 json", "type": "string" }, "host": { "description": "域名", "type": "string" }, "http_auth_base_type": { "description": "认证类型 authorization(默认Basic Auth) custom(自定义页面)", "type": "string" }, "http_auth_json": { "description": "网站密码访问的会话时效配置 json", "type": "string" }, "http_auth_path_prefix": { "description": "HTTP认证路径前缀，用于隐藏系统特征，默认为随机生成", "type": "string" }, "insecure_skip_verify": { "description": "是否开启后端https证书有效性验证 默认 0 是校验 1 是不校验", "type": "integer" }, "ip_mode": { "description": "IP提取模式: \"nic\" 网卡模式 或 \"proxy\" 代理模式", "type": "string" }, "ip_real_header": { "description": "header/cdn_preset 模式指定的真实IP头，如 CF-Connecting-IP", "type": "string" }, "ip_source_mode": { "description": "真实IP来源模式: \"\"(兼容,取XFF最左) | nic | header | xff_depth | cdn_preset", "type": "string" }, "ip_trust_depth": { "description": "xff_depth 模式：从右往左取第 N 个 hop(默认1)", "type": "integer" }, "ip_trust_proxies": { "description": "可信代理网段(CIDR/IP，逗号分隔)，用于校验真实IP头来源", "type": "string" }, "is_enable_http_auth_base": { "description": "是否 HTTPAuthBase 1 激活 非1 没有激活", "type": "integer" }, "is_enable_load_balance": { "description": "是否激活负载 1 激活 非1 没有激活", "type": "integer" }, "is_enable_response_buffering": { "description": "响应缓冲 1开启(默认) 0关闭(类似 nginx proxy_buffering off)", "type": "integer" }, "is_trans_back_domain": { "description": "是否传递后端域名到后端服务器侧", "type": "integer" }, "keyfile": { "description": "密钥文件", "type": "string" }, "load_balance_stage": { "description": "负载策略", "type": "integer" }, "log_only_mode": { "description": "是否只记录日志 1 是 0 不是", "type": "integer" }, "nickname": { "description": "网站昵称", "type": "string" }, "port": { "description": "端口", "type": "integer" }, "port_listens_json": { "description": "PortListensJSON 端口监听表(JSON)。指针语义：nil=本次请求未携带该字段(老前端/脚本)，\n落库时保持原值不动；非 nil(含空串)才写库。防止旧客户端把端口表抹空导致协议突变。", "type": "string" }, "remarks": { "description": "备注", "type": "string" }, "remote_app": { "description": "是什么类型的应用", "type": "string" }, "remote_host": { "description": "远端域名", "type": "string" }, "remote_ip": { "description": "远端指定IP", "type": "string" }, "remote_port": { "description": "远端端口", "type": "integer" }, "remote_system": { "description": "是宝塔 phpstudy等", "type": "string" }, "response_compress_json": { "description": "响应压缩配置 json", "type": "string" }, "response_time_out": { "description": "响应超时时间", "type": "integer" }, "ssl": { "description": "是否是ssl", "type": "integer" }, "start_status": { "description": "启动状态", "type": "integer" }, "static_site_json": { "description": "静态站点配置 json", "type": "string" }, "tamper_json": { "description": "网页防篡改配置 json", "type": "string" }, "transport_json": { "description": "Transport配置 json", "type": "string" }, "unrestricted_port": { "description": "不限来源匹配端口 0 限制 1，不限制", "type": "integer" }, "upload_security_json": { "description": "文件上传内容检测配置 json", "type": "string" } } }, "SamWaf_model_request.WafHostGroupAddReq": { "type": "object", "required": [ "group_name" ], "properties": { "color": { "description": "标签色，须命中 model.HostGroupColors", "type": "string" }, "group_name": { "description": "分组名称", "type": "string" }, "remarks": { "description": "备注", "type": "string" } } }, "SamWaf_model_request.WafHostGroupAssignReq": { "type": "object", "required": [ "host_codes" ], "properties": { "group_code": { "type": "string" }, "host_codes": { "type": "array", "items": { "type": "string" } } } }, "SamWaf_model_request.WafHostGroupEditReq": { "type": "object", "required": [ "group_name", "id" ], "properties": { "color": { "type": "string" }, "group_name": { "description": "只允许改名称/颜色/备注，分组短码不可变（网站在引用它）", "type": "string" }, "id": { "type": "string" }, "remarks": { "type": "string" } } }, "SamWaf_model_request.WafHostGroupSearchReq": { "type": "object", "properties": { "group_name": { "type": "string" }, "keyWord": { "description": "关键字", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" } } }, "SamWaf_model_request.WafHostGroupSortReq": { "type": "object", "required": [ "ids" ], "properties": { "ids": { "type": "array", "items": { "type": "string" } } } }, "SamWaf_model_request.WafHostGuardBanIdReq": { "type": "object", "properties": { "id": { "type": "string" } } }, "SamWaf_model_request.WafHostGuardBanSearchReq": { "type": "object", "properties": { "ip": { "type": "string" }, "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" }, "source": { "type": "string" }, "status": { "description": "留空默认只看生效中的", "type": "string" } } }, "SamWaf_model_request.WafHostGuardEventSearchReq": { "type": "object", "properties": { "action": { "description": "observe / counted / skipped / banned", "type": "string" }, "end_time": { "type": "integer" }, "fail_kind": { "type": "string" }, "ip": { "description": "模糊匹配", "type": "string" }, "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" }, "source": { "description": "ssh / rdp", "type": "string" }, "start_time": { "description": "unix秒，0=不限", "type": "integer" }, "user_name": { "description": "模糊匹配", "type": "string" } } }, "SamWaf_model_request.WafHostGuardLadderEditReq": { "type": "object", "properties": { "ladders": { "type": "array", "items": { "$ref": "#/definitions/SamWaf_model_request.WafHostGuardLadderItem" } } } }, "SamWaf_model_request.WafHostGuardLadderItem": { "type": "object", "properties": { "ban_minutes": { "description": "0=永久", "type": "integer" }, "enable": { "type": "integer" }, "level": { "type": "integer" }, "remarks": { "type": "string" } } }, "SamWaf_model_request.WafHostGuardManualBanReq": { "type": "object", "properties": { "ban_minutes": { "description": "0=永久", "type": "integer" }, "ip": { "type": "string" }, "reason": { "type": "string" }, "source": { "type": "string" } } }, "SamWaf_model_request.WafHostGuardOffenderIdReq": { "type": "object", "properties": { "id": { "type": "string" } } }, "SamWaf_model_request.WafHostGuardOffenderSearchReq": { "type": "object", "properties": { "ip": { "type": "string" }, "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" }, "source": { "type": "string" } } }, "SamWaf_model_request.WafHostGuardWhitelistAddReq": { "type": "object", "properties": { "ip": { "type": "string" } } }, "SamWaf_model_request.WafHostGuardWhitelistTestReq": { "type": "object", "properties": { "ip": { "type": "string" } } }, "SamWaf_model_request.WafHostSearchReq": { "type": "object", "properties": { "code": { "description": "主机码", "type": "string" }, "filter_by": { "description": "筛选字段", "type": "string" }, "filter_value": { "description": "筛选值", "type": "string" }, "group_code": { "description": "GroupCode 分组筛选：走精确匹配，不并入 FilterBy 那条 like 通道\n（短码走 like 会出现 \"a\" 命中 \"abc\" 的串组）。\n传 model.HostGroupNone 表示只看未分组。", "type": "string" }, "keyWord": { "description": "关键字", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" }, "remarks": { "description": "备注", "type": "string" }, "sort_by": { "description": "排序字段", "type": "string" }, "sort_descending": { "description": "排序方式", "type": "string" } } }, "SamWaf_model_request.WafHttpAuthSessionKickAllReq": { "type": "object", "required": [ "host_code" ], "properties": { "host_code": { "type": "string" } } }, "SamWaf_model_request.WafHttpAuthSessionKickByUserReq": { "type": "object", "required": [ "host_code", "user_name" ], "properties": { "host_code": { "type": "string" }, "user_name": { "type": "string" } } }, "SamWaf_model_request.WafHttpAuthSessionSearchReq": { "type": "object", "required": [ "host_code" ], "properties": { "client_ip": { "type": "string" }, "host_code": { "description": "必填，会话按站点隔离", "type": "string" }, "keyWord": { "description": "关键字", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" }, "status": { "description": "用指针：不传=全部，传0=只看已失效；普通 int 的零值会让「全部」永远查不出有效会话", "type": "integer" }, "user_name": { "type": "string" } } }, "SamWaf_model_request.WafIPFailureSetConfigReq": { "type": "object", "properties": { "enabled": { "description": "是否启用IP失败封禁 1启用 0禁用", "type": "integer" }, "lock_time": { "description": "封禁锁定时间（分钟）", "type": "integer" }, "status_codes": { "description": "失败状态码配置", "type": "string" } } }, "SamWaf_model_request.WafIPGroupAddReq": { "type": "object", "required": [ "group_name" ], "properties": { "group_name": { "description": "组名称", "type": "string" }, "remarks": { "description": "备注", "type": "string" } } }, "SamWaf_model_request.WafIPGroupEditReq": { "type": "object", "required": [ "group_name", "id" ], "properties": { "group_name": { "description": "只允许改名称与备注，组短码不可变（规则/名单都在引用它）", "type": "string" }, "id": { "type": "string" }, "remarks": { "type": "string" } } }, "SamWaf_model_request.WafIPGroupItemAddReq": { "type": "object", "required": [ "group_code", "ip" ], "properties": { "group_code": { "type": "string" }, "ip": { "description": "单IP / CIDR / 通配符 / 区间", "type": "string" }, "remarks": { "type": "string" } } }, "SamWaf_model_request.WafIPGroupItemBatchAddReq": { "type": "object", "required": [ "content", "group_code" ], "properties": { "content": { "type": "string" }, "group_code": { "type": "string" }, "remarks": { "type": "string" } } }, "SamWaf_model_request.WafIPGroupItemBatchDelReq": { "type": "object", "required": [ "ids" ], "properties": { "ids": { "type": "array", "items": { "type": "string" } } } }, "SamWaf_model_request.WafIPGroupItemDelAllReq": { "type": "object", "required": [ "group_code" ], "properties": { "group_code": { "type": "string" } } }, "SamWaf_model_request.WafIPGroupItemEditReq": { "type": "object", "required": [ "id", "ip" ], "properties": { "id": { "type": "string" }, "ip": { "type": "string" }, "remarks": { "type": "string" } } }, "SamWaf_model_request.WafIPGroupItemSearchReq": { "type": "object", "properties": { "group_code": { "type": "string" }, "ip": { "type": "string" }, "keyWord": { "description": "关键字", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" } } }, "SamWaf_model_request.WafIPGroupSearchReq": { "type": "object", "properties": { "group_code": { "type": "string" }, "group_name": { "type": "string" }, "keyWord": { "description": "关键字", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" } } }, "SamWaf_model_request.WafIPGroupValidateReq": { "type": "object", "required": [ "ip" ], "properties": { "ip": { "type": "string" } } }, "SamWaf_model_request.WafLoadBalanceAddReq": { "type": "object", "properties": { "host_code": { "description": "网站唯一码（主要键）", "type": "string" }, "remarks": { "description": "备注", "type": "string" }, "remote_ip": { "description": "远端指定IP", "type": "string" }, "remote_port": { "description": "远端端口", "type": "integer" }, "weight": { "description": "权重", "type": "integer" } } }, "SamWaf_model_request.WafLoadBalanceEditReq": { "type": "object", "properties": { "host_code": { "description": "网站唯一码（主要键）", "type": "string" }, "id": { "description": "唯一键", "type": "string" }, "remarks": { "description": "备注", "type": "string" }, "remote_ip": { "description": "远端指定IP", "type": "string" }, "remote_port": { "description": "远端端口", "type": "integer" }, "weight": { "description": "权重", "type": "integer" } } }, "SamWaf_model_request.WafLoadBalanceSearchReq": { "type": "object", "properties": { "host_code": { "description": "主机码", "type": "string" }, "keyWord": { "description": "关键字", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" }, "remote_ip": { "description": "远端指定IP", "type": "string" }, "remote_port": { "description": "远端端口", "type": "integer" } } }, "SamWaf_model_request.WafNotifyChannelAddReq": { "type": "object", "required": [ "name", "type" ], "properties": { "access_token": { "type": "string" }, "config_json": { "type": "string" }, "name": { "type": "string" }, "remarks": { "type": "string" }, "secret": { "type": "string" }, "status": { "type": "integer" }, "type": { "type": "string" }, "webhook_url": { "type": "string" } } }, "SamWaf_model_request.WafNotifyChannelEditReq": { "type": "object", "required": [ "id", "name", "type" ], "properties": { "access_token": { "type": "string" }, "config_json": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "remarks": { "type": "string" }, "secret": { "type": "string" }, "status": { "type": "integer" }, "type": { "type": "string" }, "webhook_url": { "type": "string" } } }, "SamWaf_model_request.WafNotifyChannelSearchReq": { "type": "object", "properties": { "name": { "type": "string" }, "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" }, "status": { "type": "integer" }, "type": { "type": "string" } } }, "SamWaf_model_request.WafNotifyFilterReq": { "type": "object", "properties": { "domains": { "type": "array", "items": { "type": "string" } }, "exclude_ips": { "type": "array", "items": { "type": "string" } }, "keywords": { "type": "array", "items": { "type": "string" } }, "min_severity": { "type": "string" } } }, "SamWaf_model_request.WafNotifyGlobalThrottleUpdateReq": { "type": "object", "properties": { "debug_mode": { "type": "boolean" }, "mode": { "type": "string" }, "throttle": { "$ref": "#/definitions/SamWaf_model_request.WafNotifyThrottleReq" } } }, "SamWaf_model_request.WafNotifyLogSearchReq": { "type": "object", "properties": { "channel_id": { "type": "string" }, "end_time": { "type": "string" }, "message_type": { "type": "string" }, "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" }, "start_time": { "type": "string" }, "status": { "type": "integer" } } }, "SamWaf_model_request.WafNotifySubscriptionAddReq": { "type": "object", "required": [ "channel_id", "message_type" ], "properties": { "channel_id": { "type": "string" }, "filter_json": { "type": "string" }, "message_type": { "type": "string" }, "recipients": { "type": "string" }, "remarks": { "type": "string" }, "status": { "type": "integer" } } }, "SamWaf_model_request.WafNotifySubscriptionBatchConfigReq": { "type": "object", "properties": { "apply_filter": { "description": "是否套用过滤", "type": "boolean" }, "apply_template": { "description": "是否套用模板", "type": "boolean" }, "apply_throttle": { "description": "是否套用频控", "type": "boolean" }, "channel_type": { "type": "string" }, "content_template": { "type": "string" }, "filter": { "$ref": "#/definitions/SamWaf_model_request.WafNotifyFilterReq" }, "message_type": { "type": "string" }, "throttle": { "$ref": "#/definitions/SamWaf_model_request.WafNotifyThrottleReq" }, "throttle_mode": { "type": "string" }, "title_template": { "type": "string" } } }, "SamWaf_model_request.WafNotifySubscriptionConfigReq": { "type": "object", "required": [ "id" ], "properties": { "content_template": { "type": "string" }, "filter": { "$ref": "#/definitions/SamWaf_model_request.WafNotifyFilterReq" }, "id": { "type": "string" }, "throttle": { "$ref": "#/definitions/SamWaf_model_request.WafNotifyThrottleReq" }, "throttle_mode": { "type": "string" }, "title_template": { "type": "string" } } }, "SamWaf_model_request.WafNotifySubscriptionDryRunReq": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string" } } }, "SamWaf_model_request.WafNotifySubscriptionPreviewReq": { "type": "object", "required": [ "message_type" ], "properties": { "channel_type": { "description": "影响变量转义方式（邮件走HTML转义）", "type": "string" }, "content_template": { "type": "string" }, "message_type": { "type": "string" }, "title_template": { "description": "传当前编辑中的模板，未保存也能预览", "type": "string" } } }, "SamWaf_model_request.WafNotifySubscriptionSearchReq": { "type": "object", "properties": { "channel_id": { "type": "string" }, "message_type": { "type": "string" }, "pageIndex": { "type": "integer" }, "pageSize": { "type": "integer" }, "status": { "type": "integer" } } }, "SamWaf_model_request.WafNotifySubscriptionTestReq": { "type": "object", "required": [ "id" ], "properties": { "content_template": { "type": "string" }, "id": { "type": "string" }, "title_template": { "type": "string" } } }, "SamWaf_model_request.WafNotifyThrottleReq": { "type": "object", "properties": { "aggregate_max_detail": { "description": "合并通知最多展示条数，0=继承", "type": "integer" }, "aggregate_window_sec": { "description": "聚合窗口（秒），0=继承全局", "type": "integer" }, "cooldown_reset_sec": { "description": "冷却级别重置时间（秒），0=继承", "type": "integer" }, "cooldown_steps_sec": { "description": "递增冷却梯度（秒），空=继承", "type": "array", "items": { "type": "integer" } }, "dedup_keys": { "description": "去重维度，空=继承", "type": "array", "items": { "type": "string" } }, "max_per_hour": { "description": "每小时上限，0=不限", "type": "integer" }, "quiet_hours": { "description": "免打扰时段 HH:MM-HH:MM，空=不启用", "type": "string" }, "quiet_hours_bypass_severity": { "description": "该级别及以上穿透免打扰", "type": "string" } } }, "SamWaf_model_request.WafOneKeyModSearchReq": { "type": "object", "properties": { "keyWord": { "description": "关键字", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" } } }, "SamWaf_model_request.WafOwaspCRSVarSetReq": { "type": "object", "required": [ "key" ], "properties": { "key": { "description": "变量名，可带或不带 tx. 前缀", "type": "string" }, "value": { "description": "变量值（允许空字符串以清空值）", "type": "string" } } }, "SamWaf_model_request.WafOwaspDryRunReq": { "type": "object", "properties": { "body": { "type": "string" }, "headers": { "type": "object", "additionalProperties": { "type": "string" } }, "method": { "type": "string" }, "url": { "type": "string" } } }, "SamWaf_model_request.WafOwaspRuleOverrideReq": { "type": "object", "required": [ "content", "id" ], "properties": { "content": { "type": "string" }, "id": { "type": "integer" }, "source_file": { "type": "string" } } }, "SamWaf_model_request.WafOwaspRuleResetReq": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "integer" } } }, "SamWaf_model_request.WafOwaspRuleToggleReq": { "type": "object", "required": [ "id" ], "properties": { "disabled": { "type": "boolean" }, "id": { "type": "integer" }, "source_file": { "type": "string" } } }, "SamWaf_model_request.WafParseNginxReq": { "type": "object", "properties": { "content": { "description": "source=text 时的粘贴内容", "type": "string" }, "file_path": { "description": "source=scan 时的目录", "type": "string" }, "source": { "description": "来源: \"text\" 粘贴文本 | \"scan\" 扫描目录", "type": "string" } } }, "SamWaf_model_request.WafPrivateGroupAddReq": { "type": "object", "properties": { "private_group_belong_cloud": { "type": "string" }, "private_group_name": { "type": "string" } } }, "SamWaf_model_request.WafPrivateGroupEditReq": { "type": "object", "properties": { "id": { "type": "string" }, "private_group_belong_cloud": { "type": "string" }, "private_group_name": { "type": "string" } } }, "SamWaf_model_request.WafPrivateGroupSearchByCloudReq": { "type": "object", "properties": { "keyWord": { "description": "关键字", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" }, "private_group_belong_cloud": { "type": "string" } } }, "SamWaf_model_request.WafPrivateGroupSearchReq": { "type": "object", "properties": { "keyWord": { "description": "关键字", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" } } }, "SamWaf_model_request.WafPrivateInfoAddReq": { "type": "object", "properties": { "private_group_belong_cloud": { "description": "分组归属云", "type": "string" }, "private_group_name": { "description": "分组名称", "type": "string" }, "private_key": { "type": "string" }, "private_value": { "type": "string" }, "remarks": { "type": "string" } } }, "SamWaf_model_request.WafPrivateInfoEditReq": { "type": "object", "properties": { "private_group_belong_cloud": { "description": "分组归属云", "type": "string" }, "private_group_name": { "description": "分组名称", "type": "string" }, "private_key": { "type": "string" }, "private_value": { "type": "string" }, "remarks": { "type": "string" } } }, "SamWaf_model_request.WafPrivateInfoSearchReq": { "type": "object", "properties": { "keyWord": { "description": "关键字", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" } } }, "SamWaf_model_request.WafRuleAddReq": { "type": "object", "properties": { "is_manual_rule": { "description": "0 是界面 1是纯代码", "type": "integer" }, "rule_code": { "description": "规则编号v4", "type": "string" }, "rule_content": { "description": "规则内容", "type": "string" }, "rule_json": { "type": "string" }, "rule_status": { "description": "规则状态 1 是开启 0 是关闭", "type": "integer" } } }, "SamWaf_model_request.WafRuleEditReq": { "type": "object", "properties": { "code": { "type": "string" }, "is_manual_rule": { "type": "integer" }, "rule_content": { "description": "规则内容", "type": "string" }, "rule_json": { "type": "string" }, "rule_status": { "description": "规则状态 1 是开启 0 是关闭", "type": "integer" } } }, "SamWaf_model_request.WafRuleSearchReq": { "type": "object", "properties": { "host_code": { "description": "主机码", "type": "string" }, "keyWord": { "description": "关键字", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" }, "rule_code": { "description": "规则编号v4", "type": "string" }, "rule_name": { "description": "规则名", "type": "string" } } }, "SamWaf_model_request.WafSensitiveAddReq": { "type": "object", "properties": { "action": { "description": "敏感词检测后动作 deny,replace", "type": "string" }, "check_direction": { "description": "敏感词检测方向 in ,out ,all", "type": "string" }, "content": { "description": "内容", "type": "string" }, "remarks": { "description": "备注", "type": "string" } } }, "SamWaf_model_request.WafSensitiveEditReq": { "type": "object", "properties": { "action": { "description": "敏感词检测后动作 deny,replace", "type": "string" }, "check_direction": { "description": "敏感词检测方向 in ,out ,all", "type": "string" }, "content": { "description": "内容", "type": "string" }, "id": { "type": "string" }, "remarks": { "description": "备注", "type": "string" } } }, "SamWaf_model_request.WafSensitiveSearchReq": { "type": "object", "properties": { "content": { "description": "内容", "type": "string" }, "keyWord": { "description": "关键字", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" }, "remarks": { "description": "备注", "type": "string" } } }, "SamWaf_model_request.WafSslExpireAddReq": { "type": "object", "properties": { "domain": { "type": "string" }, "port": { "type": "integer" }, "status": { "type": "string" }, "visit_log": { "type": "string" } } }, "SamWaf_model_request.WafSslExpireEditReq": { "type": "object", "properties": { "domain": { "type": "string" }, "id": { "type": "string" }, "port": { "type": "integer" }, "status": { "type": "string" }, "visit_log": { "type": "string" } } }, "SamWaf_model_request.WafSslExpireSearchReq": { "type": "object", "properties": { "domain": { "type": "string" }, "keyWord": { "description": "关键字", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" } } }, "SamWaf_model_request.WafSslorderaddReq": { "type": "object", "properties": { "apply_dns": { "description": "申请dns服务商", "type": "string" }, "apply_domain": { "description": "申请域名", "type": "string" }, "apply_email": { "description": "申请邮箱", "type": "string" }, "apply_method": { "description": "申请方式：http01(HTTP 文件验证) 或 dns01(DNS 验证)", "type": "string", "enum": [ "http01", "dns01" ] }, "apply_platform": { "description": "申请平台，取CA服务器名称（ca_server_name），默认 letsencrypt", "type": "string" }, "host_code": { "description": "网站唯一码（主要键）", "type": "string" }, "private_group_name": { "description": "密钥分组名称DNS有效", "type": "string" }, "skip_dns_verify": { "description": "dns01是否跳过本地DNS传播校验 0否 1是", "type": "integer" } } }, "SamWaf_model_request.WafSslordereditReq": { "type": "object", "properties": { "apply_dns": { "description": "申请dns服务商", "type": "string" }, "apply_domain": { "description": "申请域名", "type": "string" }, "apply_email": { "description": "申请邮箱", "type": "string" }, "apply_method": { "description": "申请方式：http01(HTTP 文件验证) 或 dns01(DNS 验证)", "type": "string", "enum": [ "http01", "dns01" ] }, "apply_platform": { "description": "申请平台，取CA服务器名称（ca_server_name），默认 letsencrypt", "type": "string" }, "apply_status": { "description": "申请状态", "type": "string" }, "host_code": { "description": "网站唯一码（主要键）", "type": "string" }, "id": { "type": "string" }, "private_group_name": { "description": "密钥分组名称DNS有效", "type": "string" }, "skip_dns_verify": { "description": "dns01是否跳过本地DNS传播校验 0否 1是", "type": "integer" } } }, "SamWaf_model_request.WafSslordersearchReq": { "type": "object", "properties": { "apply_domain": { "description": "申请域名", "type": "string" }, "host_code": { "description": "网站唯一码（主要键）", "type": "string" }, "keyWord": { "description": "关键字", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" } } }, "SamWaf_model_request.WafStatsDayRangeReq": { "type": "object", "properties": { "end_day": { "type": "string" }, "start_day": { "type": "string" } } }, "SamWaf_model_request.WafSysLogSearchReq": { "type": "object", "properties": { "keyWord": { "description": "关键字", "type": "string" }, "op_content": { "description": "操作内容", "type": "string" }, "op_type": { "description": "操作类型", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" } } }, "SamWaf_model_request.WafSystemConfigEditByItemReq": { "type": "object", "properties": { "item": { "description": "item", "type": "string" }, "value": { "description": "value", "type": "string" } } }, "SamWaf_model_request.WafSystemConfigEditReq": { "type": "object", "properties": { "id": { "type": "string" }, "item": { "description": "item", "type": "string" }, "item_class": { "description": "所属分类", "type": "string" }, "item_type": { "description": "item_type", "type": "string" }, "options": { "description": "options", "type": "string" }, "remarks": { "description": "备注", "type": "string" }, "value": { "description": "value", "type": "string" } } }, "SamWaf_model_request.WafSystemConfigSearchReq": { "type": "object", "properties": { "item": { "type": "string" }, "keyWord": { "description": "关键字", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" }, "remarks": { "type": "string" } } }, "SamWaf_model_request.WafTaskAddReq": { "type": "object", "properties": { "task_at": { "type": "string" }, "task_days_of_the_week": { "description": "周几 在周级别的情况下才起作用", "type": "string" }, "task_method": { "type": "string" }, "task_name": { "type": "string" }, "task_unit": { "type": "string" }, "task_value": { "type": "integer" } } }, "SamWaf_model_request.WafTaskEditReq": { "type": "object", "properties": { "id": { "type": "string" }, "task_at": { "type": "string" }, "task_days_of_the_week": { "description": "周几 在周级别的情况下才起作用", "type": "string" }, "task_method": { "type": "string" }, "task_name": { "type": "string" }, "task_unit": { "type": "string" }, "task_value": { "type": "integer" } } }, "SamWaf_model_request.WafTaskSearchReq": { "type": "object", "properties": { "keyWord": { "description": "关键字", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" } } }, "SamWaf_model_request.WafTunnelAddReq": { "type": "object", "properties": { "allow_ip": { "type": "string" }, "allowed_time_ranges": { "type": "string" }, "code": { "type": "string" }, "conn_timeout": { "type": "integer" }, "deny_ip": { "type": "string" }, "ip_version": { "type": "string" }, "max_in_connect": { "type": "integer" }, "max_out_connect": { "type": "integer" }, "name": { "type": "string" }, "port": { "type": "string" }, "protocol": { "type": "string" }, "read_timeout": { "type": "integer" }, "remark": { "type": "string" }, "remote_ip": { "type": "string" }, "remote_port": { "type": "integer" }, "ssl_certificate": { "type": "string" }, "ssl_certificate_key": { "type": "string" }, "ssl_protocols": { "type": "string" }, "ssl_status": { "type": "integer" }, "start_status": { "type": "integer" }, "write_timeout": { "type": "integer" } } }, "SamWaf_model_request.WafTunnelEditReq": { "type": "object", "properties": { "allow_ip": { "type": "string" }, "allowed_time_ranges": { "type": "string" }, "code": { "type": "string" }, "conn_timeout": { "type": "integer" }, "deny_ip": { "type": "string" }, "id": { "type": "string" }, "ip_version": { "type": "string" }, "max_in_connect": { "type": "integer" }, "max_out_connect": { "type": "integer" }, "name": { "type": "string" }, "port": { "type": "string" }, "protocol": { "type": "string" }, "read_timeout": { "type": "integer" }, "remark": { "type": "string" }, "remote_ip": { "type": "string" }, "remote_port": { "type": "integer" }, "ssl_certificate": { "type": "string" }, "ssl_certificate_key": { "type": "string" }, "ssl_protocols": { "type": "string" }, "ssl_status": { "type": "integer" }, "start_status": { "type": "integer" }, "write_timeout": { "type": "integer" } } }, "SamWaf_model_request.WafTunnelSearchReq": { "type": "object", "properties": { "keyWord": { "description": "关键字", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" } } }, "SamWaf_model_request.WafUpgradeNoticeIdReq": { "type": "object", "properties": { "notice_id": { "type": "string" } } }, "SamWaf_model_request.WafUpgradeNoticeSearchReq": { "type": "object", "properties": { "keyWord": { "description": "关键字", "type": "string" }, "kind": { "description": "notice / action / check，空=全部", "type": "string" }, "lang": { "description": "zh_CN / en_US，空=中文", "type": "string" }, "pageIndex": { "description": "当前页面索引", "type": "integer" }, "pageSize": { "description": "每页大小", "type": "integer" }, "status": { "description": "pending / done / ignored，空=全部", "type": "string" }, "version": { "description": "按引入版本过滤，空=全部", "type": "string" } } }, "SamWaf_model_request.WafVpConfigDomainWhitelistUpdateReq": { "type": "object", "properties": { "domain_whitelist": { "description": "多个域名用逗号分隔，为空表示不限制", "type": "string" } } }, "SamWaf_model_request.WafVpConfigIpWhitelistUpdateReq": { "type": "object", "properties": { "ip_whitelist": { "description": "IP白名单，多个IP用逗号分隔", "type": "string" } } }, "SamWaf_model_request.WafVpConfigManageTrustedProxiesUpdateReq": { "type": "object", "properties": { "trusted_proxies": { "description": "可信代理网段（CIDR/IP，逗号分隔，留空=不信任任何代理头）", "type": "string" } } }, "SamWaf_model_request.WafVpConfigNoticeTitleUpdateReq": { "type": "object", "properties": { "notice_title": { "description": "通知消息标题前缀，用于区分多实例", "type": "string" } } }, "SamWaf_model_request.WafVpConfigSecurityEntryUpdateReq": { "type": "object", "properties": { "entry_enable": { "description": "是否启用安全路径", "type": "boolean" }, "entry_path": { "description": "安全路径码，为空时自动生成", "type": "string" } } }, "SamWaf_model_request.WafVpConfigSslBindCertUpdateReq": { "type": "object", "properties": { "ssl_config_id": { "description": "绑定的证书夹(SslConfig)ID，为空表示解绑", "type": "string" } } }, "SamWaf_model_request.WafVpConfigSslEnableUpdateReq": { "type": "object", "properties": { "ssl_enable": { "description": "是否启用SSL", "type": "boolean" } } }, "SamWaf_model_request.WafVpConfigSslForceHttpsUpdateReq": { "type": "object", "properties": { "force_https": { "description": "是否仅允许HTTPS访问（开启后纯HTTP请求301跳转到HTTPS）", "type": "boolean" } } }, "SamWaf_model_request.WafVpConfigSslUploadReq": { "type": "object", "properties": { "cert_content": { "description": "证书内容", "type": "string" }, "key_content": { "description": "私钥内容", "type": "string" } } }, "SamWaf_model_response.UpgradeNoticeItem": { "type": "object", "properties": { "applied_time": { "type": "string" }, "applied_user": { "type": "string" }, "apply_type": { "description": "none / navigate / config_set", "type": "string" }, "detail": { "type": "string" }, "doc": { "description": "官方文档链接", "type": "string" }, "effect_off": { "description": "不做会怎样（必须写代价）", "type": "string" }, "effect_on": { "description": "做了之后有什么变化", "type": "string" }, "fresh_install": { "description": "是否属于\"全新安装建议\"", "type": "boolean" }, "kind": { "description": "notice / action / check", "type": "string" }, "level": { "description": "high / normal / low", "type": "string" }, "notice_id": { "type": "string" }, "page": { "description": "「去设置」跳转的站内路径", "type": "string" }, "revert": { "description": "怎么撤销", "type": "string" }, "status": { "description": "pending / done / ignored", "type": "string" }, "title": { "type": "string" }, "version": { "description": "引入版本", "type": "string" } } }, "SamWaf_model_response.UpgradeNoticeSummary": { "type": "object", "properties": { "current_version": { "type": "string" }, "downgrade": { "description": "Downgrade 旧程序 + 新库（容器重建后回退到镜像自带版本，issue #938）。\n过去只打日志、界面完全看不见，这里把它暴露出来。", "type": "boolean" }, "downgrade_msg": { "type": "string" }, "from_version": { "description": "本次升级的起点，空=无历史记录", "type": "string" }, "high_pending_count": { "type": "integer" }, "need_popup": { "description": "NeedPopup 仅当存在 level=high 且未处理、且从未弹过时为 true。\n弹窗一辈子只弹一次，回写靠 /popupshown。", "type": "boolean" }, "pending_count": { "type": "integer" }, "popup_items": { "type": "array", "items": { "$ref": "#/definitions/SamWaf_model_response.UpgradeNoticeItem" } }, "to_version": { "type": "string" }, "total_count": { "type": "integer" } } }, "model.Hosts": { "type": "object", "properties": { "access_json": { "description": "统一访问认证(Access模式)站点级配置 json（三态开关/路径白名单）", "type": "string" }, "anti_leech_json": { "description": "防盗链配置 json", "type": "string" }, "auto_jump_https": { "description": "是否自动跳转https 0 不自动 1 强制80跳转https", "type": "integer" }, "bind_more_host": { "description": "绑定多域名", "type": "string" }, "bind_more_port": { "description": "是否绑定多个端口", "type": "string" }, "bind_ssl_id": { "description": "绑定SSL的ID", "type": "string" }, "cache_json": { "description": "缓存配置 json", "type": "string" }, "captcha_json": { "description": "验证码配置 json", "type": "string" }, "cdn_provider": { "description": "cdn_preset 模式选择的 CDN 厂商: cloudflare|fastly|cloudfront|edgeone|aliyun|akamai", "type": "string" }, "certfile": { "description": "证书文件", "type": "string" }, "code": { "description": "唯一码", "type": "string" }, "cookie_security_json": { "description": "Cookie安全保护配置 json（HttpOnly/Secure/SameSite）", "type": "string" }, "create_time": { "description": "创建时间", "type": "string" }, "csrf_json": { "description": "CSRF防护配置 json（Origin/Referer 强校验）", "type": "string" }, "custom_headers_json": { "description": "自定义头信息配置 json", "type": "string" }, "custom_response_headers_json": { "description": "自定义响应头信息配置 json", "type": "string" }, "default_encoding": { "description": "默认编码 utf-8 或者 gbk auto字符串自动选择", "type": "string" }, "defense_json": { "description": "自身防御 json", "type": "string" }, "disable_http2": { "description": "对外HTTP/2开关 0启用(默认/现状) 1关闭(该站点ALPN只提供http/1.1,兼容安卓等原生WebSocket客户端)", "type": "integer" }, "emergency_mode": { "description": "EmergencyMode 紧急模式（对标 Under Attack Mode）：1=开启，全部页面请求先过一次人机验证。\n\n它是站点级总闸，不改动任何一条 CC 规则——把规则的动作改掉再改回来，\n中间出任何岔子都恢复不回原样，而这个开关多半是在被打的时候按的。\n「永不挑战的路径」对它同样生效：App/API 客户端跑不了 JS 挑战，必须留得出口。", "type": "integer" }, "emergency_until": { "description": "EmergencyUntil 紧急模式自动关闭时间(unix 秒)，0=手动关闭前一直开着。\n默认给一个到期时间：这个开关会让全部访客多走一道挑战，忘了关的代价由真实用户承担。", "type": "integer" }, "exclude_ip_log": { "description": "排除记录日志的IP清单 换行或逗号隔开：单IP/CIDR/通配符/区间/group:组短码", "type": "string" }, "exclude_url_log": { "description": "排除的url开头的数据 换行隔开", "type": "string" }, "global_host": { "description": "默认全局 1 全局 0非全局", "type": "integer" }, "group_code": { "description": "GroupCode 所属分组短码，空=未分组。\n纯管理端组织维度：只用于列表筛选与批量选择，不参与任何请求期判定，也不下发引擎（见 model/host_group.go）。", "type": "string" }, "guard_status": { "description": "防御状态 1 是开启防御 0 是防御关闭", "type": "integer" }, "healthy_json": { "description": "后端健康度检测 json", "type": "string" }, "host": { "description": "域名", "type": "string" }, "http_auth_base_type": { "description": "认证类型 authorization(默认Basic Auth) custom(自定义页面)", "type": "string" }, "http_auth_json": { "description": "网站密码访问的会话时效配置 json（有效期/空闲超时/绑定登录IP），空=按 DecodeHttpAuthConfig 的默认值", "type": "string" }, "http_auth_path_prefix": { "description": "HTTP认证路径前缀，用于隐藏系统特征，默认为随机生成", "type": "string" }, "id": { "type": "string" }, "insecure_skip_verify": { "description": "是否开启后端https证书有效性验证 默认 0 是校验 1 是不校验", "type": "integer" }, "ip_mode": { "description": "IP提取模式: \"nic\" 网卡模式 或 \"proxy\" 代理模式", "type": "string" }, "ip_real_header": { "description": "header/cdn_preset 模式指定的真实IP头，如 CF-Connecting-IP", "type": "string" }, "ip_source_mode": { "description": "真实客户端 IP 提取加固（向后兼容：IPSourceMode 为空时行为与旧版完全一致——取 X-Forwarded-For 最左第一个）", "type": "string" }, "ip_trust_depth": { "description": "xff_depth 模式：从右往左取第 N 个非可信 hop(默认1)", "type": "integer" }, "ip_trust_proxies": { "description": "可信代理网段(CIDR/IP，逗号分隔)，用于 xff_depth 跳过可信 hop", "type": "string" }, "is_enable_http_auth_base": { "description": "是否 HTTPAuthBase 1 激活 非1 没有激活", "type": "integer" }, "is_enable_load_balance": { "description": "是否激活负载 1 激活 非1 没有激活", "type": "integer" }, "is_enable_response_buffering": { "description": "响应缓冲 1开启(默认) 0关闭(类似 nginx proxy_buffering off，边收边推，利于流式/SSE/大文件)", "type": "integer" }, "is_trans_back_domain": { "description": "是否传递后端域名到后端服务器侧", "type": "integer" }, "keyfile": { "description": "密钥文件", "type": "string" }, "load_balance_stage": { "description": "负载策略", "type": "integer" }, "log_only_mode": { "description": "仅记录模式 1开启 0关闭", "type": "integer" }, "nickname": { "description": "网站昵称", "type": "string" }, "port": { "description": "端口", "type": "integer" }, "port_listens_json": { "description": "PortListensJSON 端口监听表(JSON)，形如 [{\"port\":80,\"proto\":\"http\",\"ipv\":\"both\"}]。\n空 = 按老规则从 Ssl/BindMorePort/AutoJumpHTTPS 派生（存量站点保持原行为）。\naddr 为预留字段：当前版本不生效，引擎读到会忽略并按通配监听。\n解析唯一入口 utils.ResolveHostListens，其它地方不得自行解析。", "type": "string" }, "remarks": { "description": "备注", "type": "string" }, "remote_app": { "description": "是什么类型的应用", "type": "string" }, "remote_host": { "description": "远端域名", "type": "string" }, "remote_ip": { "description": "远端指定IP", "type": "string" }, "remote_port": { "description": "远端端口", "type": "integer" }, "remote_system": { "description": "是宝塔 phpstudy等", "type": "string" }, "response_compress_json": { "description": "响应压缩配置 json（Gzip/Brotli/Zstd）", "type": "string" }, "response_time_out": { "description": "响应超时时间 默认60秒,为0则无限等待", "type": "integer" }, "ssl": { "description": "是否是ssl", "type": "integer" }, "start_status": { "description": "启动状态 如果是0 启动 ; 如果是1 不启动", "type": "integer" }, "static_site_json": { "description": "静态站点配置 json", "type": "string" }, "tamper_json": { "description": "网页防篡改配置 json（响应基线比对）", "type": "string" }, "tenant_id": { "description": "租户ID", "type": "string" }, "transport_json": { "description": "传输配置 json", "type": "string" }, "unrestricted_port": { "description": "不限来源匹配端口 0 限制 1，不限制", "type": "integer" }, "update_time": { "description": "更新时间", "type": "string" }, "upload_security_json": { "description": "文件上传内容检测配置 json（扩展名/Webshell/类型/大小）", "type": "string" }, "user_code": { "description": "用户码（主要键）", "type": "string" } } }, "model.Rules": { "type": "object", "properties": { "create_time": { "description": "创建时间", "type": "string" }, "host_code": { "description": "主机唯一码", "type": "string" }, "id": { "type": "string" }, "is_manual_rule": { "description": "是否为手工写规则 1：手工编写 0 ：UI界面形式", "type": "integer" }, "is_public_rule": { "description": "是否为公共规则", "type": "integer" }, "rule_code": { "description": "规则的唯一码", "type": "string" }, "rule_content": { "description": "规则内容", "type": "string" }, "rule_content_json": { "description": "规则JSON内容", "type": "string" }, "rule_name": { "description": "规则名称", "type": "string" }, "rule_status": { "description": "规则是否开启 1，开启 0，关闭不生效 999 删除", "type": "integer" }, "rule_version": { "description": "规则版本号", "type": "integer" }, "rule_version_name": { "description": "规则版本名", "type": "string" }, "salience": { "description": "Salience 规则优先级，不落库：从 RuleContent 里解析出来供列表展示\n优先级本身写在规则文本(GRL)里，手工模式和界面模式都有，所以统一从文本解析，无需加数据库列", "type": "integer" }, "tenant_id": { "description": "租户ID", "type": "string" }, "update_time": { "description": "更新时间", "type": "string" }, "user_code": { "description": "用户码（主要键）", "type": "string" } } }, "model.RuntimeSystemInfo": { "type": "object", "properties": { "arch": { "description": "编译目标架构 amd64/arm64", "type": "string" }, "container": { "description": "容器类型：空=非容器；docker/podman/containerd/lxc", "type": "string" }, "go_version": { "description": "编译器版本", "type": "string" }, "in_kubernetes": { "description": "是否运行在 Kubernetes 中", "type": "boolean" }, "is_win7_build": { "description": "当前二进制是否 Win7 专版", "type": "boolean" }, "is_win7_kernel": { "description": "当前系统是否 Win7/Win8/Server2008R2 内核", "type": "boolean" }, "is_windows": { "description": "特殊环境标记(前端按条件展示)", "type": "boolean" }, "is_wsl": { "description": "是否运行在 WSL 中", "type": "boolean" }, "kernel_arch": { "description": "内核架构(真实机器架构)", "type": "string" }, "kernel_version": { "description": "内核版本", "type": "string" }, "os": { "description": "编译信息", "type": "string" }, "os_name": { "description": "操作系统信息", "type": "string" }, "platform": { "description": "平台 如 ubuntu", "type": "string" }, "platform_version": { "description": "平台版本 如 24.04", "type": "string" }, "process_uptime_seconds": { "description": "SamWaf 进程已运行时长(秒)", "type": "integer" }, "run_as_service": { "description": "是否以系统服务方式启动", "type": "boolean" }, "system_uptime_seconds": { "description": "运行时长", "type": "integer" }, "version": { "description": "软件信息", "type": "string" }, "version_name": { "description": "软件版本 如 20241028", "type": "string" }, "version_release": { "description": "是否正式版 \"true\"/\"false\"", "type": "string" }, "virtualization": { "description": "虚拟化类型 如 kvm/vmware/hyperv，空=未识别", "type": "string" }, "web_version": { "description": "内嵌管理端前端版本", "type": "string" } } }, "model.VersionInfo": { "type": "object", "properties": { "container": { "description": "容器类型：空=非容器；docker/podman/containerd/lxc/oci\n容器环境下应用内升级只在本次容器生命周期有效，容器重建即回退，故前端应引导用户改用更新镜像的方式", "type": "string" }, "need_update": { "type": "boolean" }, "self_update_allowed": { "description": "当前环境是否允许走应用内升级（容器环境默认为 false，可由 allow_container_selfupdate 配置放行）", "type": "boolean" }, "version": { "type": "string" }, "version_desc": { "type": "string" }, "version_name": { "type": "string" }, "version_new": { "type": "string" }, "version_release": { "type": "string" }, "web_version": { "description": "内嵌管理端前端版本", "type": "string" } } } }, "securityDefinitions": { "ApiKeyAuth": { "type": "apiKey", "name": "X-API-Key", "in": "header" } } }