版本 2.4.7.20261116085428 · 最新

防重放 site-replay-guards

单个站点的防重放设置:受保护接口须带一次性令牌或 App 签名头,没有或重放时拦截或验证;可单独设置或恢复按方案;属 WAF 增强。

点击任一接口,右侧显示对应的调用示例。

防护鉴权: 用户(部分参数仅管理员)3 个接口

鉴权

请求头带 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-replay-guards/{site_id}获取站点防重放设置

鉴权: 用户(部分参数仅管理员)

PUT/api/v2/site-replay-guards/{site_id}设置站点防重放

鉴权: 用户(部分参数仅管理员)

请求体 application/json

字段类型说明
actionReplayGuardAction 没有令牌或重放时:block 回 403;challenge 出 JS 挑战。不写 = block。
可选值 ["block","challenge"]
app_saltstring 签名盐(应用密钥,32 字节 hex);app_sign 开而没有它 = 签名头一律不认。
app_signboolean App 签名校验:请求带签名头即按签名校验,不需要令牌。
bind_ipboolean 令牌再绑客户端 IP(换 IP 即失效)。
enabled必填boolean 是否开启。
expected_updated_atstring 乐观锁:调用方读到的 updated_at(读到为空 = 还没设置过,用 1970-01-01T00:00:00Z)。与库里当前值不等则回 409 stale_version、不保存;不带则不检查。
methodsReplayGuardMethod[] 受保护方法;不写 = POST/PUT/PATCH/DELETE。
pathsReplayGuardPath[] 保护接口路径表,最多 64 条;空 = 不保护。
ttl_sinteger 令牌有效期(秒),签名头的时间戳也按它判;不写 = 120。

防重放对象

字段类型说明
actionReplayGuardAction 没有令牌或重放时:block 回 403;challenge 出 JS 挑战。不写 = block。
可选值 ["block","challenge"]
app_saltstring 签名盐(应用密钥,32 字节 hex);app_sign 开而没有它 = 签名头一律不认。
app_signboolean App 签名校验:请求带签名头即按签名校验,不需要令牌。
bind_ipboolean 令牌再绑客户端 IP(换 IP 即失效)。
enabledboolean 是否开启。
expected_updated_atstring 乐观锁:调用方读到的 updated_at(读到为空 = 还没设置过,用 1970-01-01T00:00:00Z)。与库里当前值不等则回 409 stale_version、不保存;不带则不检查。
gatestring 站点租户的 WAF 增强判定档:full 可改;readonly 到期只读缓冲内(License.readonly_days,缺省 7 天)照常生效、设置只读;basic 没开通或缓冲已过,不生效、设置保留。
只读可选值 ["full","readonly","basic"]
gate_expired_atstring 仅管理员响应且 gate_reason=expired 时带:平台 WAF 增强授权的到期时刻;租户响应不带。
只读
gate_ownerWafGateOwner 站点属主,仅管理员响应带;租户响应不带别人的信息。
只读
gate_packagesstring[] 仅管理员响应带:属主名下未到期的套餐名(最多 20 个);租户响应不带。
只读
gate_reasonWafGateReason WAF 增强(waf_enhanced)没生效的原因,gate 为 full 或 readonly 时不带。package = 平台已授权但属主没有未到期且含 WAF 增强的套餐;license = 平台没开通(从未授权、服务商撤销、授权被停用);expired = 平台授权已到期且只读缓冲期(License.readonly_days,缺省 7 天)已过,已回落基础。
只读可选值 ["package","license","expired"]
methodsReplayGuardMethod[] 受保护方法;不写 = POST/PUT/PATCH/DELETE。
pathsReplayGuardPath[] 保护接口路径表,最多 64 条;空 = 不保护。
site_idinteger 网站 ID
只读
sourceProtectSiteSource 站点这一项的来源:scheme 按方案(保存方案时跟着变);custom 单独设置(含关闭、存量迁移来的行)。
只读可选值 ["scheme","custom"]
ttl_sinteger 令牌有效期(秒),签名头的时间戳也按它判;不写 = 120。
updated_atstring 版本(没设过为空);修改时用 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"
}
开始使用

123

123