版本 2.4.8 · 最新
防篡改 site-tamper-guards
单个站点的网页防篡改设置:保护范围(首页、整页、目录)、检查范围(仅结构变化 / 整页任意变化)、篡改时返回基准页或仅告警、观察期;更新基准与看差异;属 WAF 增强。
点击任一接口,右侧显示对应的调用示例。
防护鉴权: 用户(部分参数仅管理员)5 个接口
鉴权
请求头带 X-API-Key(在「API 密钥」页开通,密钥只在开通时显示一次);也可用登录得到的 Authorization: Bearer 令牌。
X-API-Key
鉴权失败回 401;无权回 403(code 为 insufficient_scope 等)。
约定
分页参数 page(从 1 起)、page_size;排序 sort=字段 或 -字段。
时间一律 RFC 3339(UTC);金额单位为分。
写操作成功回 200/201/204;重复提交按资源唯一键回 409。
GET
/api/v2/site-tamper-guards/{site_id}获取站点防篡改设置
鉴权: 用户(部分参数仅管理员)
PUT
/api/v2/site-tamper-guards/{site_id}设置站点防篡改
鉴权: 用户(部分参数仅管理员)
请求体 application/json
| 字段 | 类型 | 说明 |
|---|---|---|
action | string | 篡改时的处置。 |
enabled必填 | boolean | 是否开启。 |
expected_updated_at | string | 乐观锁:调用方读到的 updated_at(读到为空 = 还没设置过,用 1970-01-01T00:00:00Z)。与库里当前值不等则回 409 stale_version、不保存;不带则不检查。 |
mode | string | 检查范围。 |
observe_days | integer | 新开启时观察的天数。 |
scopes | SiteTamperScope[] | 保护范围。 |
DELETE
/api/v2/site-tamper-guards/{site_id}站点防篡改恢复按方案
鉴权: 用户(部分参数仅管理员)
GET
/api/v2/site-tamper-guards/{site_id}/diff看站点防篡改差异
鉴权: 用户(部分参数仅管理员)
查询参数
| 字段 | 类型 | 说明 |
|---|---|---|
path必填 | string | 基准页路径(如 /、/about.html)。 |
POST
/api/v2/site-tamper-guards/{site_id}/rebase更新站点防篡改基准
鉴权: 用户(部分参数仅管理员)
防篡改对象
| 字段 | 类型 | 说明 |
|---|---|---|
action | string | 篡改时的处置。 |
assets | SiteTamperAsset[] | 指纹不符的 JS/CSS(只记录,不替换)。 |
base_at | string | 基准时间(最近一次更新基准)。 |
base_ver | integer | 基准版本,每次更新基准 +1;0 = 还没有基准。 |
changes | SiteTamperChange[] | 结构变化(删掉的链接与正文变化不列)。 |
enabled | boolean | 是否开启。 |
expected_updated_at | string | 乐观锁:调用方读到的 updated_at(读到为空 = 还没设置过,用 1970-01-01T00:00:00Z)。与库里当前值不等则回 409 stale_version、不保存;不带则不检查。 |
fetch_error | string | 现抓这一页没成的原因(此时 changes 为空):fetch_failed 源站非 200 或连不上;not_html 不是网页;too_large 超 1MB。抓到时不出。 |
gate | string | 站点租户的 WAF 增强判定档:full 可改;readonly 到期只读缓冲内(License.readonly_days,缺省 7 天)照常生效、设置只读;basic 没开通或缓冲已过,不检测、设置保留。 |
gate_expired_at | string | 仅管理员响应且 gate_reason=expired 时带:平台 WAF 增强授权的到期时刻;租户响应不带。 |
gate_owner | WafGateOwner | 站点属主,仅管理员响应带;租户响应不带别人的信息。 |
gate_packages | string[] | 仅管理员响应带:属主名下未到期的套餐名(最多 20 个);租户响应不带。 |
gate_reason | WafGateReason | WAF 增强(waf_enhanced)没生效的原因,gate 为 full 或 readonly 时不带。package = 平台已授权但属主没有未到期且含 WAF 增强的套餐;license = 平台没开通(从未授权、服务商撤销、授权被停用);expired = 平台授权已到期且只读缓冲期(License.readonly_days,缺省 7 天)已过,已回落基础。 |
mode | string | 检查范围。 |
observe_days | integer | 新开启时观察的天数。 |
observe_until | string | 观察期截止;为空 = 不在观察期(没开过或开时选了 0 天)。 |
pages | SiteTamperPage[] | 基准页(按路径排序),含没纳入的保护范围与原因。 |
path | string | 页面路径。 |
scopes | SiteTamperScope[] | 保护范围。 |
site_id | integer | 网站 ID |
source | ProtectSiteSource | 站点这一项的来源:scheme 按方案(保存方案时跟着变);custom 单独设置(含关闭、存量迁移来的行)。 |
tampered | boolean | 按站点检查范围算不算篡改。 |
updated_at | string | 版本(没设过为空);修改时用 expected_updated_at。 |
返回与错误
成功直接回资源 JSON(HTTP 2xx);失败回 application/problem+json(code、detail,校验失败带 errors);列表为 items + total。
成功
{
"id": 1,
"name": "example"
}列表
{
"items": [
{
"id": 1
}
],
"page": 1,
"page_size": 20,
"total": 1
}失败
{
"code": "validation_failed",
"detail": "请求参数不合法",
"errors": [
{
"code": "required",
"field": "/name",
"message": "name 必填"
}
],
"request_id": "0123456789abcdef",
"status": 422,
"title": "Unprocessable Entity",
"type": "about:blank"
}