网站 sites

CDN 加速站点。新建至少要域名与源站;管理员可跨租户管理。

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

网站鉴权: 用户(部分参数仅管理员)30 个接口

鉴权

请求头带 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/sites列出站点

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

查询参数

字段类型说明
pageinteger 页码,从 1 开始。
默认 1
page_sizeinteger 每页条数。
默认 20
sortstring 排序字段,逗号分隔,前缀 `-` 表示降序,如 `-created_at,id`。
tenant_idinteger 仅管理员可用:按租户过滤(格式错 422)。租户凭据调用时忽略,只返回本租户数据。
tenant_idsstring 仅管理员可用:只看这些租户,逗号分隔的正整数,去重后至多 200 个(超了或格式错 422);只选 1 个也可用。只做过滤、不切换请求作用域,与 tenant_id 及其他条件取交集;租户凭据带了非空值回 403。
idsstring 只列这些 id:逗号分隔的正整数,去重后至多 200 个(同 page_size 上限,超了或格式错 422);空串等同不传。与其他条件取交集;看不到的 id 不返回也不报错。分页照旧,一次取回要把 page_size 设成不少于 id 个数。
domainstring 按域名子串过滤(不分大小写):a.example.com 也会命中 www.a.example.com;精确查用 domains。
domainsstring 多个域名逗号分隔,站点任一域名与其中之一整项相同即命中(不分大小写,不做子串匹配)。
group_idinteger 只列该分组里的站点。
group_idsstring 多个分组 id 逗号分隔(正整数,去重后至多 200 个),站点在其中任一分组里即命中;可与 group_id 同用(两者都要满足)。
appstring 按体检识别出的程序(report_checkup_sites.app,如 wordpress)精确过滤;还没体检过的站点不命中。
enabledboolean 按启停过滤。
idinteger 按站点 id 精确过滤。
namestring 按名称子串过滤。
originstring 按源站主机子串过滤。
stop_codeinteger 按停服码过滤;0 = 正常。
upidinteger 按用户套餐过滤。
http_portinteger 只列 HTTP 监听端口(config.http_ports)里有这个端口的站点,整段匹配。
https_portinteger 只列 HTTPS 监听端口(config.https.ports)里有这个端口的站点;没开 HTTPS 的不算,整段匹配。
https_enabledboolean true 只列开了 HTTPS(config.https 有监听端口)的站点,false 只列没开的。
upidsstring 按用户套餐(多个)过滤:逗号分隔的正整数,去重后至多 200 个(超了或格式错 422);只选 1 个也可用;与其他条件取交集。
package_idinteger 按基础套餐过滤。
region_idinteger 按区域过滤:接入名的主线路分组属于该区域;没有自己接入名的按所属已售套餐的共用接入名算。
node_group_idinteger 按线路分组过滤:接入名的主线路分组或备用线路分组是它。
cname_domain_idinteger 按接入根域过滤。
package_idsstring 按基础套餐(多个)过滤,语义同 package_id:逗号分隔的正整数,去重后至多 200 个(超了或格式错 422);只选 1 个也可用;与其他条件取交集。
region_idsstring 按区域(多个)过滤,语义同 region_id:逗号分隔的正整数,去重后至多 200 个(超了或格式错 422);只选 1 个也可用;与其他条件取交集。
node_group_idsstring 按线路分组(多个)过滤,语义同 node_group_id:逗号分隔的正整数,去重后至多 200 个(超了或格式错 422);只选 1 个也可用;与其他条件取交集。
cname_domain_idsstring 按接入根域(多个)过滤,语义同 cname_domain_id:逗号分隔的正整数,去重后至多 200 个(超了或格式错 422);只选 1 个也可用;与其他条件取交集。
cname_hostnamestring 按接入名主机记录精确过滤。
sync_statestring 按配置同步状态过滤:behind = 配置落后(还有在线节点没装上它最近一次修改后的配置版本);
可选值 ["behind","synced"]
POST/api/v2/sites创建站点

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

查询参数

字段类型说明
tenant_idinteger 管理员代建时的属主租户(必填);租户调用时忽略,属主恒为本人。

请求体 application/json

字段类型说明
cnameCnameBinding 接入名(CNAME):用户把域名 CNAME 到 fqdn,解析由平台按节点组生成;没有接入名时为 null。
configobject 节点配置字段(schema/site.json 的顶层字段,去掉 id、uid、upid、domains、origins、enabled、stop_code、rulesets)。
domains必填string[] 站点绑定的域名。
enabledboolean 是否启用
group_idsinteger[] 站点所属分组的 id。
namestring 名称
origins必填SiteOrigin[] 源站列表。
stop_codeinteger 0 = 正常;非 0 = 所有请求回这个状态码(管理员/计费设置)。
upidinteger 用户套餐 id(套餐域上线前可空;快照里空时取 tenant_id)。
POST/api/v2/sites/batch批量操作站点

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

查询参数

字段类型说明
tenant_idinteger 管理员代建时的属主租户(必填);租户调用时忽略,属主恒为本人。

请求体 application/json

字段类型说明
action必填string 批量动作:set_enabled(启停)、delete(删除)、set_groups(设置分组)、set_origins(整组替换源站)、update_config(合并配置)、create(批量新建)。
可选值 ["set_enabled","delete","set_groups","set_origins","update_config","create"]
configobject 节点配置字段(schema/site.json 的顶层字段,去掉 id、uid、upid、domains、origins、enabled、stop_code、rulesets)。
enabledboolean 是否启用
group_idsinteger[] 站点所属分组的 id。
idsinteger[] 要操作的站点 id(最多 100 个;create 以外的动作必填)。
itemsSiteWrite[] create 用:要新建的站点(最多 100 个),每条同 POST /sites 的请求体。
originsSiteOrigin[] 源站列表。
POST/api/v2/sites/batch-patch批量修改网站配置

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

请求体 application/json

字段类型说明
changes必填object 键为提交指针(/config/... /upid /origins /group_ids /ip_list/black /ip_list/white /cache_group_id /cache_overlay /l2/enabled /l2/origin_l2_only /l2/l2_group_id /l2/origin_max_conns /l2/l2_pick、/config/https#ssl_mode、/config/https#cert_match),值为新值;null 删除该键。
ids必填integer[] 要操作的站点 id(最多 100 个;create 以外的动作必填)。
POST/api/v2/sites/checkup-fix-batch批量一键修复体检问题

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

请求体 application/json

字段类型说明
batchstring 只用于 rec_type:分段修复时带上第一段返回的批次号,各段的撤销快照记在同一批里;不带则新开一批。
ids必填integer[] 要操作的站点 id(最多 100 个;create 以外的动作必填)。
key必填string 要修复的体检项键,含义同单站一键修复。
可选值 ["no_https","tls_old","sec_headers","waf_block","cc_mid","rec_type","waf_level","origin_https","cert_expiring","login_limit","upload_unscanned","upload_sig","leak_phone","sensitive_files"]
GET/api/v2/sites/checkup-fix-batches列出最近的体检修复批次

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

查询参数

字段类型说明
tenant_idinteger 仅管理员可用:按租户过滤(格式错 422)。租户凭据调用时忽略,只返回本租户数据。
POST/api/v2/sites/config-summary汇总多个网站的配置取值

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

请求体 application/json

字段类型说明
fields必填string[] 要汇总的字段指针(批量修改字段表原文)。
ids必填integer[] 要操作的站点 id(最多 100 个;create 以外的动作必填)。
with_idsboolean 为 true 时每个取值另回 ids(取这个值的站点 id,升序,最多 100000 个);只能单字段请求(fields 恰好 1 个),否则 400 invalid。
GET/api/v2/sites/origin-alerts源站内容不一致告警

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

查询参数

字段类型说明
site_idinteger 只看该站点。
POST/api/v2/sites/protect-recommend/apply批量套用推荐防护配置

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

请求体 application/json

字段类型说明
ids必填integer[] 要操作的站点 id(最多 100 个;create 以外的动作必填)。
observe_daysinteger 覆盖推荐表里 waf_mode 的先观察天数(0 = 直接拦截);缺省按推荐表。
skipstring[] 用户取消勾选、本次不套用的推荐项。
type必填string 网站类型:企业官网、电商、内容资讯、API 服务、后台管理、下载分发。
可选值 ["corporate","shop","content","api","admin","download"]
POST/api/v2/sites/protect-recommend/preview预览推荐防护配置的影响

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

请求体 application/json

字段类型说明
ids必填integer[] 要操作的站点 id(最多 100 个;create 以外的动作必填)。
observe_daysinteger 覆盖推荐表里 waf_mode 的先观察天数(0 = 直接拦截);缺省按推荐表。
skipstring[] 用户取消勾选、本次不套用的推荐项。
typestring 网站类型:企业官网、电商、内容资讯、API 服务、后台管理、下载分发。
可选值 ["corporate","shop","content","api","admin","download"]
POST/api/v2/sites/protect-recommend/undo撤销一批推荐防护配置

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

请求体 application/json

字段类型说明
batch必填string 只用于 rec_type:分段修复时带上第一段返回的批次号,各段的撤销快照记在同一批里;不带则新开一批。
ids必填integer[] 要操作的站点 id(最多 100 个;create 以外的动作必填)。
POST/api/v2/sites/region-check地区限制保存前检查

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

请求体 application/json

字段类型说明
region_limit必填object 要检查的地区限制(同 Site.config.region_limit)。
POST/api/v2/sites/select-ids取筛选结果的全部站点 id

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

查询参数

字段类型说明
tenant_idinteger 仅管理员可用:按租户过滤(格式错 422)。租户凭据调用时忽略,只返回本租户数据。

请求体 application/json

字段类型说明
appstring 按体检识别出的程序精确过滤。
cname_domain_idinteger 按接入根域过滤。
cname_domain_idsinteger[] 按接入根域(多个)过滤,语义同 cname_domain_id(去重后至多 200 个);在其中任一即命中,与其他条件取交集。
cname_hostnamestring 按接入名主机记录精确过滤(不分大小写,不含根域)。
domainstring 按域名子串过滤(不分大小写)。
domainsstring[] 站点绑定的域名。
enabledboolean 是否启用
group_idinteger 只取该分组里的站点。
group_idsinteger[] 站点所属分组的 id。
http_portinteger 只取 HTTP 监听端口里有这个端口的站点,整段匹配(80 不命中 8080)。
https_enabledboolean true 只取开了 HTTPS 的站点,false 只取没开的。
https_portinteger 只取 HTTPS 监听端口里有这个端口的站点;没开 HTTPS 的不算,整段匹配。
idinteger 记录 ID
idsinteger[] 要操作的站点 id(最多 100 个;create 以外的动作必填)。
namestring 名称
node_group_idinteger 按线路分组过滤:接入名的主线路分组或备用线路分组是它。
node_group_idsinteger[] 按线路分组(多个)过滤,语义同 node_group_id(去重后至多 200 个);在其中任一即命中,与其他条件取交集。
originstring 按源站主机子串过滤。
package_idinteger 按基础套餐过滤(所属已售套餐由该基础套餐购得)。
package_idsinteger[] 按基础套餐(多个)过滤,语义同 package_id(去重后至多 200 个);在其中任一即命中,与其他条件取交集。
region_idinteger 按区域过滤:接入名的主线路分组属于该区域;没有自己接入名的按所属已售套餐的共用接入名算。
region_idsinteger[] 按区域(多个)过滤,语义同 region_id(去重后至多 200 个);在其中任一即命中,与其他条件取交集。
stop_codeinteger 0 = 正常;非 0 = 所有请求回这个状态码(管理员/计费设置)。
sync_statestring 按配置同步状态过滤:behind = 配置落后(还有在线节点没装上它最近一次修改后的配置版本);synced = 已同步。
可选值 ["behind","synced"]
tenant_idsinteger[] 仅管理员可用:只取这些租户的站点(去重后至多 200 个);只做过滤、不切换请求作用域,与 tenant_id 查询参数取交集;租户凭据带了非空值回 403。
upidinteger 用户套餐 id(套餐域上线前可空;快照里空时取 tenant_id)。
upidsinteger[] 只取这些用户套餐下的站点,在其中任一套餐即命中;可与 upid 同用(两者都要满足)。
with_domainboolean 为 true 时响应另回 items(每站 id 与首个域名),给批量修改列已选站点。
GET/api/v2/sites/{id}获取站点

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

PUT/api/v2/sites/{id}修改站点

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

请求体 application/json

字段类型说明
cnameCnameBinding 接入名(CNAME):用户把域名 CNAME 到 fqdn,解析由平台按节点组生成;没有接入名时为 null。
configobject 节点配置字段(schema/site.json 的顶层字段,去掉 id、uid、upid、domains、origins、enabled、stop_code、rulesets)。
domainsstring[] 站点绑定的域名。
enabledboolean 是否启用
expected_updated_atstring 乐观锁(修改时用):调用方读到的该资源 updated_at。与库里当前值不等则回 409 stale_version、不保存;不带则不检查。
group_idsinteger[] 站点所属分组的 id。
namestring 名称
originsSiteOrigin[] 源站列表。
stop_codeinteger 0 = 正常;非 0 = 所有请求回这个状态码(管理员/计费设置)。
upidinteger 用户套餐 id(套餐域上线前可空;快照里空时取 tenant_id)。
DELETE/api/v2/sites/{id}删除站点

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

POST/api/v2/sites/{id}/checkup-fix一键修复体检问题

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

请求体 application/json

字段类型说明
key必填string 要修复的体检项键,含义同单站一键修复。
可选值 ["no_https","tls_old","sec_headers","waf_block","cc_mid","rec_type","waf_level","origin_https","cert_expiring","login_limit","upload_unscanned","upload_sig","leak_phone","sensitive_files"]
GET/api/v2/sites/{id}/health站点回源健康状态

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

GET/api/v2/sites/{id}/l2查看网站分层回源

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

PATCH/api/v2/sites/{id}/l2修改网站分层回源

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

请求体 application/json

字段类型说明
enabledboolean 是否启用
l2_group_idinteger 使用的 L2 组;null = 区域默认。
l2_pickstring 本站选 L2 的方式;null = 跟默认设置。
可选值 ["region","near"]
origin_l2_onlyboolean 源站只允许 L2 访问:动态请求也经 L2,本区域没 L2 时借用其他区域。
origin_max_connsinteger 源站最大并发(每节点在途);0 = 不限,超了排队不报 503。
GET/api/v2/sites/{id}/l2-egress-ips源站放行清单

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

查询参数

字段类型说明
fmtstring text 的格式:ip 每行一个、nginx allow 行、iptables 规则;缺省 ip。
可选值 ["ip","nginx","iptables"]默认 "ip"
GET/api/v2/sites/{id}/l2-stats网站的分层回源统计

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

查询参数

字段类型说明
start必填string 起始时间(含),RFC 3339。
end必填string 结束时间(不含),RFC 3339。
PUT/api/v2/sites/{id}/site-type设置网站类型

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

请求体 application/json

字段类型说明
type必填string 网站类型:企业官网、电商、内容资讯、API 服务、后台管理、下载分发。
可选值 ["corporate","shop","content","api","admin","download"]
GET/api/v2/sites/{id}/speed站点加速效果

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

查询参数

字段类型说明
rangestring 统计窗口,缺省 24h。
可选值 ["1h","24h","7d"]默认 "24h"
countrystring 只看来自该国家/地区的请求(ISO 3166-1 两位代码,与访问日志 country 同值)。
ispstring 只看该运营商的请求(与访问日志 isp 同值)。
http_verstring 只看该 HTTP 协议版本的请求。
可选值 ["1.0","1.1","2","3"]
POST/api/v2/sites/{id}/upload-scan/false-positive标记站点的上传扫描误报

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

请求体 application/json

字段类型说明
pathstring 路径前缀(以 / 开头);不给取 /。
sha256string 命中文件的 sha256(小写十六进制);租户提交时须是本站上传命中事件里出现过的指纹;给了且情报共享开着、sig 非空时同事务内记一条误报情报待上报。
sigstring 误报的特征名(事件规则名,如 webshell.php.eval);空 = 该路径整段不扫描(此时必须给 path)。
DELETE/api/v2/sites/{id}/upload-scan/false-positive撤销站点标记的上传扫描误报

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

查询参数

字段类型说明
path必填string 例外的路径前缀。
sigstring 例外的特征名;不给或空 = 路径整段例外。
POST/api/v2/sites/{id}/url-guard/revoke手动撤销站点在途的全网 URL 防护

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

请求体 application/json

字段类型说明
pathstring 路径前缀(以 / 开头);不给取 /。

网站对象

字段类型说明
action必填string 批量动作:set_enabled(启停)、delete(删除)、set_groups(设置分组)、set_origins(整组替换源站)、update_config(合并配置)、create(批量新建)。
可选值 ["set_enabled","delete","set_groups","set_origins","update_config","create"]
added_atstring 加入时间;早期手工条目没有。
affectedinteger 受影响的条数
appstring 按体检识别出的程序精确过滤。
as_ofstring 数据截至:用量与访问日志在窗口里都已覆盖到的最新时刻(取两者较早的;只有一路有数据取那一路),不晚于 end;窗口里都没数据为 null。
basisstring totals 与 points 的来源:usage 为实时用量(无筛选);log 为按抽样权重还原的访问日志(带了筛选)。
可选值 ["usage","log"]
batchstring 只用于 rec_type:分段修复时带上第一段返回的批次号,各段的撤销快照记在同一批里;不带则新开一批。
capacity_warningsSiteCapacityWarning[] 只在建站(POST /sites)与改到别的线路分组(PUT /sites/{id})的响应里、目标线路分组有节点站数已达内存容量上限时给出;只提示不拦截,没有超限节点时不给这个字段。
只读
changes必填object 键为提交指针(/config/... /upid /origins /group_ids /ip_list/black /ip_list/white /cache_group_id /cache_overlay /l2/enabled /l2/origin_l2_only /l2/l2_group_id /l2/origin_max_conns /l2/l2_pick、/config/https#ssl_mode、/config/https#cert_match),值为新值;null 删除该键。
checked_atstring 本次向节点要明细的时间。
cnameCnameBinding 接入名(CNAME):用户把域名 CNAME 到 fqdn,解析由平台按节点组生成;没有接入名时为 null。
cname_domain_idinteger 按接入根域过滤。
cname_domain_idsinteger[] 按接入根域(多个)过滤,语义同 cname_domain_id(去重后至多 200 个);在其中任一即命中,与其他条件取交集。
cname_hostnamestring 按接入名主机记录精确过滤(不分大小写,不含根域)。
conditionsobject 键为父开关指针(/config 形式)或 /config/region_limit/mode;父开关回 on / off,地区限制模式回 block / allow。
configobject 节点配置字段(schema/site.json 的顶层字段,去掉 id、uid、upid、domains、origins、enabled、stop_code、rulesets)。
countrystring 国家/地区编号,没有不给。
created_atstring 创建时间
只读
default_pickstring 默认设置当前的方式(l2_pick 为 null 时生效)。
可选值 ["region","near"]
domainstring 按域名子串过滤(不分大小写)。
domainsstring[] 站点绑定的域名。
edge_origin_requestsinteger 边缘回源请求数(命中率分母)。
enabledboolean 是否启用
endstring 窗口右端(不含):当前时间取整到 5 分钟。
expected_updated_atstring 乐观锁(修改时用):调用方读到的该资源 updated_at。与库里当前值不等则回 409 stale_version、不保存;不带则不检查。
facetsSiteSpeedFacets 各筛选维度窗口里有请求的取值,按请求数降序;每个维度按其余维度的筛选条件算,不含本维度自己的筛选;未识别的空值不列。
fields必填string[] 要汇总的字段指针(批量修改字段表原文)。
foundboolean 库里查到了这个 IP(否则按未识别的访客判)。
group_idinteger 只取该分组里的站点。
group_idsinteger[] 站点所属分组的 id。
group_optionsL2SiteRefGroup[] 可选的自建 L2 组。
h3_off_nodesSiteSpeedH3Off 本站当前解析到的节点组里被主控判为 UDP 443 不通(不宣告 HTTP/3)的节点;没开 HTTP/3 探测、站点没有接入名或全部可达时不出该字段。
hit_ratenumber 命中率 0–1;没有回源为 0。
http_portinteger 只取 HTTP 监听端口里有这个端口的站点,整段匹配(80 不命中 8080)。
https_enabledboolean true 只取开了 HTTPS 的站点,false 只取没开的。
https_portinteger 只取 HTTPS 监听端口里有这个端口的站点;没开 HTTPS 的不算,整段匹配。
idinteger 记录 ID
只读
idsinteger[] 要操作的站点 id(最多 100 个;create 以外的动作必填)。
ipstring 调用者的 IP。
ispstring 运营商编号,没有不给。
itemsSiteWrite[] create 用:要新建的站点(最多 100 个),每条同 POST /sites 的请求体。
key必填string 要修复的体检项键,含义同单站一键修复。
可选值 ["no_https","tls_old","sec_headers","waf_block","cc_mid","rec_type","waf_level","origin_https","cert_expiring","login_limit","upload_unscanned","upload_sig","leak_phone","sensitive_files"]
l2_group_idinteger 使用的 L2 组;null = 区域默认。
l2_hit_requestsinteger L2 接住的回源请求数(命中率分子)。
l2_pickstring 本站选 L2 的方式;null = 跟默认设置。
可选值 ["region","near"]
logSiteSpeedLog 按原始访问日志(按采样权重折算)统计的协议分布、回源耗时分位、未命中地址抽样与边缘响应耗时,窗口同 totals。
log_keep_daysinteger 原始访问日志保留天数(reports.access_log_days);窗口超出它时 log 只统计还留着的部分。
missingstring[] 选了但当前库不含数据的字段(这些选择不会命中)。
namestring 名称
node_group_idinteger 按线路分组过滤:接入名的主线路分组或备用线路分组是它。
node_group_idsinteger[] 按线路分组(多个)过滤,语义同 node_group_id(去重后至多 200 个);在其中任一即命中,与其他条件取交集。
node_issuesNodeIssue[] 在线节点上站点没完全生效的口或原因(列表与详情里给);都正常时不给这个字段。
只读
nodesSiteHealthNode[] 各在用节点的明细(按节点 id 升序)。
observe_daysinteger 覆盖推荐表里 waf_mode 的先观察天数(0 = 直接拦截);缺省按推荐表。
originstring 按源站主机子串过滤。
origin_changesSiteOriginChange[] set_origins 时各站的源站旧→新,按 ids 升序。
origin_l2_onlyboolean 源站只允许 L2 访问:动态请求也经 L2,本区域没 L2 时借用其他区域。
origin_max_connsinteger 源站最大并发(每节点在途);0 = 不限,超了排队不报 503。
origin_requestsinteger 实际到源站的请求数。
origin_requests_estinteger 未开分层时的估算(= 边缘回源请求数)。
originsSiteOrigin[] 源站列表。
package_idinteger 按基础套餐过滤(所属已售套餐由该基础套餐购得)。
package_idsinteger[] 按基础套餐(多个)过滤,语义同 package_id(去重后至多 200 个);在其中任一即命中,与其他条件取交集。
pathstring 路径前缀(以 / 开头);不给取 /。
pointedboolean 除通配域名外的域名都已指向本平台。
pointsSiteSpeedPoint[] 按桶的明细(只列有流量的桶)。
provstring 省份编号,没有不给。
publish_seqinteger 只在建站、改站的响应里给:这次写操作的序号(同响应头 Publish-Seq),拿它调 GET /config-publish/applied?seq= 查是否已推到节点。
只读
rangestring 统计窗口(1h、24h 或 7d)。
rec_verinteger 本次用的推荐表版本。
region_idinteger 按区域过滤:接入名的主线路分组属于该区域;没有自己接入名的按所属已售套餐的共用接入名算。
region_idsinteger[] 按区域(多个)过滤,语义同 region_id(去重后至多 200 个);在其中任一即命中,与其他条件取交集。
region_limit必填object 要检查的地区限制(同 Site.config.region_limit)。
region_namesstring[] 有可用 L2 的区域名,按区域 id 排;个数等于 regions。
regionsinteger 有可用 L2 的区域数。
resultsSiteBatchPatchItem[] 逐站结果,按请求顺序(重复的站点只出一条)。
revokedstring[] 已撤销的路径。
revoking_untilstring 即将停用的停用时刻:授权收回时刻、授权回落窗口截止、网站所属租户的套餐窗口截止取最早;只在 state=revoking 且能确定时刻时给(冻结等没有截止时不给)。
saved_bytesinteger 省的回源流量(L2 命中字节)。
sha256string 命中文件的 sha256(小写十六进制);租户提交时须是本站上传命中事件里出现过的指纹;给了且情报共享开着、sig 非空时同事务内记一条误报情报待上报。
sigstring 误报的特征名(事件规则名,如 webshell.php.eval);空 = 该路径整段不扫描(此时必须给 path)。
site_idinteger 网站 id;0 = 所有网站。
skipstring[] 用户取消勾选、本次不套用的推荐项。
sourcestring user 手选;auto 按流量自动判定。
可选值 ["user","auto"]
startstring 窗口起点。
statestring 生效状态:on 生效;off 网站没开;not_open 没开通(含网站所属租户的套餐不含分层回源);paused 全网暂停;no_l2 没有可用的 L2;revoking 生效中但即将停用。
可选值 ["on","off","not_open","paused","no_l2","revoking"]
statusstring disabled 没开主动健康检查;unknown 没有节点回明细;healthy 回了明细的节点上源站全部在线;unhealthy 有源站被摘除。
stop_codeinteger 0 = 正常;非 0 = 所有请求回这个状态码(管理员/计费设置)。
sync_statestring 按配置同步状态过滤:behind = 配置落后(还有在线节点没装上它最近一次修改后的配置版本);synced = 已同步。
可选值 ["behind","synced"]
tenant_idinteger 所属租户(用户)ID
只读
tenant_idsinteger[] 仅管理员可用:只取这些租户的站点(去重后至多 200 个);只做过滤、不切换请求作用域,与 tenant_id 查询参数取交集;租户凭据带了非空值回 403。
textstring 按 fmt 排好的文本,可直接粘贴到源站。
totalsSiteSpeedTotals 整个窗口的合计。
type必填string 网站类型:企业官网、电商、内容资讯、API 服务、后台管理、下载分发。
可选值 ["corporate","shop","content","api","admin","download"]
updated_atstring 更新时间
只读
upidinteger 用户套餐 id(套餐域上线前可空;快照里空时取 tenant_id)。
upidsinteger[] 只取这些用户套餐下的站点,在其中任一套餐即命中;可与 upid 同用(两者都要满足)。
verdictstring 调用者访问首页的结果:pass 放行、block 被拦、log 只记录。
可选值 ["pass","block","log"]
waf_gateSiteWafGate 只在站点详情(GET /sites/{id})里给:站点属主的 WAF 增强状态与没生效的原因。owner、packages、expired_at 仅管理员响应带,租户响应只有 gate 与 reason。列表行只有 waf_gate_reason。
只读
waf_gate_reasonWafGateReason WAF 增强(waf_enhanced)没生效的原因,gate 为 full 或 readonly 时不带。package = 平台已授权但属主没有未到期且含 WAF 增强的套餐;license = 平台没开通(从未授权、服务商撤销、授权被停用);expired = 平台授权已到期且只读缓冲期(License.readonly_days,缺省 7 天)已过,已回落基础。
只读可选值 ["package","license","expired"]
with_domainboolean 为 true 时响应另回 items(每站 id 与首个域名),给批量修改列已选站点。
with_idsboolean 为 true 时每个取值另回 ids(取这个值的站点 id,升序,最多 100000 个);只能单字段请求(fields 恰好 1 个),否则 400 invalid。

返回与错误

成功直接回资源 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"
}
开始使用

体验在线演示

访问在线演示,或联系我们获取报价与安装命令