版本 2.4.7.20261116085428 · 最新

Bot 设置 bot-settings

平台级 Bot 管理:按六类(搜索引擎 / 监控·工具 / 自动化工具 / AI 爬虫 / 无头浏览器 / 恶意 Bot)与伪造爬虫设处置方式、验证方式、行为评分分段、保护接口与例外,仅管理员可改;无头浏览器、恶意 Bot、伪造爬虫处置与行为评分属付费功能 WAF 增强。站点在站点配置 bot 里逐类覆盖。

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

防护鉴权: 仅管理员2 个接口

鉴权

请求头带 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。

PUT/api/v2/bot-settings修改 Bot 设置

鉴权: 仅管理员

请求体 application/json

字段类型说明
actionsobject 按类处置;缺省搜索引擎、监控·工具放行,自动化工具与 AI 爬虫只记录,无头浏览器验证,恶意 Bot 与伪造爬虫拦截。headless、malicious、fake 属 WAF 增强。
challengestring 处置为 challenge 时的验证方式:js 无感、slide 滑块、rotate 旋转图片、click 点选、captcha 字符(缺省 js)。
可选值 ["js","slide","rotate","click","captcha"]
enabledboolean 总开关;false = 所有站点都不做 Bot 判定。
enhancedstring WAF 增强判定档:full 已开通、readonly 到期只读缓冲内(License.readonly_days,缺省 7 天;增强项照常生效但只读)、basic 未开通或缓冲已过(无头浏览器、恶意 Bot、伪造爬虫按普通访客,不打分,设置保留);修改时忽略。
可选值 ["full","readonly","basic"]
exceptionsobject[] 例外:命中的请求不做 Bot 判定(path、cidr、ja4 至少一项,同一条里多项须同时满足)。
expected_updated_atstring 乐观锁:调用方读到的 updated_at(配置 node.global 的版本,与 CC/WAF 设置共用;读到为空用 1970-01-01T00:00:00Z)。与库里当前值不等则回 409 stale_version、不保存;不带则不检查。
protectstring[] 保护接口(路径前缀,如 /login,WAF 增强):没看过页面直接请求它们加分。
scoreobject 行为评分分段(WAF 增强,0–100):低于 js 放行;js 到 slide 无感验证;slide 到 block 按 kind 验证;达到 block 按恶意 Bot 处置。须 js < slide < block。通过验证的访客 30 分钟内分数清零。
updated_atstring 响应里的版本(node.global 配置键的 updated_at,没改过为空);修改时忽略。

Bot 设置对象

字段类型说明
actionsobject 按类处置;缺省搜索引擎、监控·工具放行,自动化工具与 AI 爬虫只记录,无头浏览器验证,恶意 Bot 与伪造爬虫拦截。headless、malicious、fake 属 WAF 增强。
challengestring 处置为 challenge 时的验证方式:js 无感、slide 滑块、rotate 旋转图片、click 点选、captcha 字符(缺省 js)。
可选值 ["js","slide","rotate","click","captcha"]
enabledboolean 总开关;false = 所有站点都不做 Bot 判定。
enhancedstring WAF 增强判定档:full 已开通、readonly 到期只读缓冲内(License.readonly_days,缺省 7 天;增强项照常生效但只读)、basic 未开通或缓冲已过(无头浏览器、恶意 Bot、伪造爬虫按普通访客,不打分,设置保留);修改时忽略。
只读可选值 ["full","readonly","basic"]
exceptionsobject[] 例外:命中的请求不做 Bot 判定(path、cidr、ja4 至少一项,同一条里多项须同时满足)。
expected_updated_atstring 乐观锁:调用方读到的 updated_at(配置 node.global 的版本,与 CC/WAF 设置共用;读到为空用 1970-01-01T00:00:00Z)。与库里当前值不等则回 409 stale_version、不保存;不带则不检查。
protectstring[] 保护接口(路径前缀,如 /login,WAF 增强):没看过页面直接请求它们加分。
scoreobject 行为评分分段(WAF 增强,0–100):低于 js 放行;js 到 slide 无感验证;slide 到 block 按 kind 验证;达到 block 按恶意 Bot 处置。须 js < slide < block。通过验证的访客 30 分钟内分数清零。
updated_atstring 响应里的版本(node.global 配置键的 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