API 参考 v2.1.1792967583
15 个分组 · 419 个接口
鉴权
请求头带 X-API-Key(在「API 密钥」页开通,密钥只在开通时显示一次);也可用登录得到的 Authorization: Bearer 令牌。
X-API-Key
- 有 X-API-Key 先验密钥(未过期、未删除)
- 否则验 Authorization: Bearer 访问令牌
- 再按密钥的授权范围与接口的作用域判断(租户只能操作本租户的资源)
鉴权失败回 401;无权回 403(code 为 insufficient_scope 等)。
返回与错误
成功直接回资源 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"
}约定
- 分页参数 page(从 1 起)、page_size;排序 sort=字段 或 -字段。
- 时间一律 RFC 3339(UTC);金额单位为分。
- 写操作成功回 200/201/204;重复提交按资源唯一键回 409。
资源
登录认证
用户账号
用户管理
users管理员管理平台账号:增删改查、启停、重设口令、关闭动态口令。删除前须先停用。13 个接口当前用户 me当前登录用户查看或修改自己的资料、实名认证与界面偏好。6 个接口API 密钥 api-keys当前用户的 API 密钥。密钥明文只在创建时返回一次,可按领域限定授权范围。4 个接口注册须知 registration-info无需认证。返回注册是否开放、各字段是否必填或需验证、用户协议。1 个接口注册 registrations无需认证。提交注册信息建出租户账号;须同意用户协议,要验证的邮箱或手机须带验证码。1 个接口验证码 verify-codes无需认证。发送邮件或短信验证码,用于注册绑定、找回密码和登录二次验证;短信须带图形验证码。1 个接口登录策略 login-policy无需认证。按账号查询是否要邮件或短信验证码登录,以及打码后的收码目标。1 个接口实名通道 certify-channels仅管理员:支付宝身份验证与腾讯云慧眼(微信人脸核身)的商户凭据;用哪个通道在账号设置 certify_provider 里选。2 个接口支付与账户
我的账户
account当前用户自己的余额与冻结状态;管理员改用户账户走用户管理下的账户接口。1 个接口订单 orders充值、扣款、在线支付与套餐购买产生的订单;租户只见本租户,管理员可跨租户,订单只许改备注。4 个接口账户流水 ledger-entries账户余额的每一笔变动,每条带记账后的余额快照。1 个接口在线支付 payments发起在线充值:建一张待支付订单并向支付网关预下单,返回付款地址。1 个接口充值方式 payment-methods当前可用的在线支付方式、默认方式与转账说明,充值页据此渲染。1 个接口支付通道 payment-channels管理员配置支付方式走哪家网关及各网关商户参数;密钥只写不回显。2 个接口支付回调 payment-notifications支付网关调用的结果通知入口,无需认证,按网关规则验签后入账,重复通知只入账一次。2 个接口DNS 与接入
DNS 服务商
dns-providers仅管理员。保存 DNS 服务商账号(阿里云、Cloudflare 等);保存前在线校验凭据,凭据只回末 4 位提示。6 个接口CNAME 接入域名 cname-domains仅管理员。用于生成 CNAME 接入名的根域,归属某个 DNS 服务商账号;支持整体更换到新根域并核对客户是否已改解析。12 个接口解析同步 dns-sync仅管理员。让调度器立刻按期望解析全量对账一次(面板「记录修复」)。1 个接口节点调度
区域
regions节点所属的地理区域,用于给节点和节点组归类。5 个接口节点 nodes已审核的边缘节点与子 IP;主节点经注册令牌自助注册,子 IP 由管理员手工添加。8 个接口待接入节点 pending-nodes已用令牌注册、等待管理员审核的节点;审核通过后成为正式节点。3 个接口节点接入令牌 node-enroll-tokens生成一次性注册令牌与节点一行安装命令;令牌原文只在生成时返回一次。1 个接口节点分组 node-groups把线路编成组并对应一个接入名;可设置备用阈值,可用线路不足时自动切到备用组。5 个接口线路 lines节点组里的一条解析记录:节点按哪条 DNS 解析线路、多少权重出现在组里;删除前须先停用。5 个接口告警规则 alert-rules主控内置的统一告警规则及其当前设置与状态;阈值通过系统设置修改。1 个接口告警记录 alerts最近的告警与恢复记录,保留 30 天。1 个接口节点监控日志 monitor-logs主控对开启监控的节点 IP 每轮探测的结果记录。1 个接口IP 产品线
IP 池
ip-pools管理员维护的 IP 池及池内 IP;池按区域归属,名称全平台唯一。12 个接口IP 站点 ip-sites用 IP 加自定义端口对外提供加速的站点;须先在用户套餐里选好 IP。7 个接口证书
证书
certs上传或自动签发的 HTTPS 证书。可绑定到站点;有站点在用时不能删除或停用。14 个接口ACME 账号 acme-accounts自动签发证书用的 CA 账号(Let's Encrypt、ZeroSSL)。第一次签发时才向 CA 注册。5 个接口DNS API(证书验证) dns-apisDNS 服务商的 API 凭据,用于 DNS-01 验证与签发通配证书。凭据只写,响应只回掩码。5 个接口证书设置 cert-settings当前用户新建证书时的默认类型;留空则跟随平台。2 个接口面板证书 panel-cert仅管理员。面板自己用的 HTTPS 证书状态;一键用面板域名自动申请 Let's Encrypt 证书,续签随证书管理。2 个接口文件验证 pki-validations仅管理员。为 CA 的文件验证提供内容,由节点转主控代答,到期后不再应答。3 个接口防护
访问控制(ACL)
acls按 IP/CIDR 等条件放行或拦截请求的规则集;平台提供内置规则,租户可自建。6 个接口CC 匹配器 cc-matchesCC 防护里用来识别请求的条件;可复用到多个规则组。6 个接口CC 过滤器 cc-filters对命中的请求限频或发起挑战(JS、滑块、验证码等)的处理方式。5 个接口CC 规则 cc-rules把匹配器与过滤器按序组合成的 CC 规则组,站点可选用其中一组。6 个接口封禁 bans被拉黑的 IP 记录,可手动封禁、按 IP 或整站解封并查解封记录,也包含节点上报的自动封禁。8 个接口站点黑白名单 site-ip-lists单个站点的永久 IP 黑名单与白名单;黑名单命中即断开,白名单命中跳过 CC 等防护。也可清空站点在各节点上的临时白名单。7 个接口全局黑白名单 global-ip-lists平台级 IP 黑名单与白名单(全网生效),条目可带到期时间、原因与来源,支持批量导入导出;仅管理员可改。4 个接口CC 设置 cc-settings平台级 CC 默认规则组与自动切换设置,仅管理员可改。2 个接口Bot 设置 bot-settings平台级 Bot 管理:按五类(搜索引擎 / 监控·工具 / 自动化工具 / 无头浏览器 / 恶意 Bot)与伪造爬虫设处置方式、验证方式、行为评分分段、保护接口与例外,仅管理员可改;无头浏览器、恶意 Bot、伪造爬虫处置与行为评分属付费功能 WAF 增强。站点在站点配置 bot 里逐类覆盖。2 个接口Bot 统计 bot-statsBot 管理页顶部统计与分类表「今日请求」列:今日请求数、按 Bot 分类的请求与处置分项、防重放启用网站数、节点升级进度;租户只看自己网站。1 个接口WAF 设置 waf-settings平台级 WAF 全网总开关、缺省拦截阈值与请求体检查上限,仅管理员可改;站点各自的观察/拦截与例外在站点配置 waf 里。2 个接口上传防护设置 upload-scan-settings平台级上传文件扫描(只查 multipart 表单上传的文件):总开关、危险扩展名、双扩展名、伪装文件、木马特征、病毒库、单文件上限、扫描超时、处置与例外,仅管理员可改;木马特征、病毒库与 sha256 黑名单属付费功能 WAF 增强。2 个接口上传扫描统计 upload-scan-stats上传防护页顶部统计:今日扫描、拦截、超上限未扫的次数,以及扫不了的网站列表;仅管理员可看。1 个接口高危 IP 库 intel平台下发的高危 IP 库(付费项 WAF 规则更新,每小时同步)的状态、全局处置策略、条目查询、单条加白与今日来访命中;租户只读。5 个接口增值防护方案 protect-schemes防重放、防泄露、防篡改各一份方案(租户各自一份,管理员编辑平台方案);保存时一并改「按方案」的站点,单独设置的不动;属 WAF 增强。9 个接口防重放 site-replay-guards单个站点的防重放设置:受保护接口须带一次性令牌或 App 签名头,没有或重放时拦截或验证;可单独设置或恢复按方案;属 WAF 增强。3 个接口防泄露 site-leak-guards单个站点的防泄露设置:查源站返回的网页、JSON 与文本里的手机号、身份证号、银行卡号、密钥和报错信息,按打码、拦截或换错误页处置;属 WAF 增强。3 个接口全网 URL 防护设置 url-guard-settings平台级全网 URL 防护的缺省开关与阈值,仅管理员可改;站点各自的开关与阈值在站点安全配置里。2 个接口全网 URL 防护 url-guard按 URL 跨节点汇总请求量,超阈值后对该 URL 临时下发的挑战/限速/拦截规则,到时自动撤销;此处只读查看生效中的条目。1 个接口威胁情报上报记录 intel-reports本主控向服务商匿名上报威胁情报(自动封禁的高危 IP、上传扫描命中/误报、新出现的文件指纹)的批次记录,每 5 分钟一批;情报共享关闭时不上报。仅管理员可查看。1 个接口防篡改 site-tamper-guards单个站点的网页防篡改设置:保护范围(首页、整页、目录)、检查范围(仅结构变化 / 整页任意变化)、篡改时返回基准页或仅告警、观察期;更新基准与看差异;属 WAF 增强。5 个接口防篡改保护页面总表 tamper-guard跨网站列出全部保护页面(网站、路径、范围、基准时间、状态、最近变化),不用先选网站;租户只看自己的网站,可按网站筛选。1 个接口套餐
套餐
packages可售卖的基础套餐,定义流量、带宽、域名数等额度与价格。7 个接口套餐分组 package-groups把套餐分组展示,便于客户选购。5 个接口升级包 package-upgrades在基础套餐之上按份加购的额度或功能。5 个接口套餐目录 package-catalog客户可购买的套餐、分组与升级包目录。1 个接口已购套餐 user-packages租户已购买的套餐:购买、续费、更换、加购升级包与用量查看。16 个接口套餐监控 package-monitor仅管理员:近 1 分钟各用户套餐的带宽与连接数。2 个接口网站
缓存
缓存分组
cache-groups一组缓存规则,可供多个站点引用;分平台分组与租户自建分组。7 个接口缓存策略 cache-policy设置本租户的默认缓存分组,并可把全部站点改回按默认分组。3 个接口缓存标配 cache-presets出厂标配缓存规则,可作为新建缓存分组的参考。1 个接口站点缓存方式 cache-sites查看或设置单个站点使用的缓存分组或自定义规则。2 个接口刷新与预热 cache-jobs刷新(清除)缓存的 URL 或目录,以及预热指定 URL。3 个接口刷新预热限额 cache-quota每日刷新与预热的限额及今日已用量。1 个接口四层转发
四层转发
streamsTCP/UDP 端口转发规则。每条规则含监听端口与协议、源站列表、负载方式;(协议, 端口) 全平台唯一。6 个接口转发分组 stream-groups给四层转发规则分组,便于批量管理;同租户分组名唯一,分组里还有转发时不能删除。5 个接口分层回源
消息
消息
messages站内信与公告;管理员发布公告,租户查看、标记已读。8 个接口消息订阅 message-subscriptions选择要接收哪些类型的通知。2 个接口发信通道 message-channels邮件(SMTP)与短信发信通道的配置及测试。3 个接口告警 Webhook message-webhooks钉钉、飞书、企业微信、Telegram 与通用 JSON 告警出口,可配多个,地址与密钥只回后 4 位。6 个接口