接口文档 · v2.4.8
控制台能做的,
控制台能做的,
代码都能做。
490 个接口,对应控制台里的各项操作:API 密钥鉴权、统一的错误格式,可直接接入您的发布系统、运维平台或 AI 助手。
$ curl -X POST "https://panel.example.com/api/v2/cache-jobs" \ -H "X-API-Key: $GOCDN_API_KEY" \ -H "Content-Type: application/json" \ -d '{"type":"purge_url","urls":["https://www.example.com/index.html"]}' # 返回示例 · 密钥为占位符 {"id":1,"name":"example"}
490个接口
18个分组
X-API-Key密钥鉴权
problem+json统一错误格式
RFC 3339时间格式 · UTC
鉴权
请求头带 X-API-Key(在「API 密钥」页开通,密钥只在开通时显示一次);也可用登录得到的 Authorization: Bearer 令牌。
X-API-Key
- 1有 X-API-Key 先验密钥(未过期、未删除)
- 2否则验 Authorization: Bearer 访问令牌
- 3再按密钥的授权范围与接口的作用域判断(租户只能操作本租户的资源)
鉴权失败回 401;无权回 403(code 为 insufficient_scope 等)。
约定
分页参数 page(从 1 起)、page_size;排序 sort=字段 或 -字段。
时间一律 RFC 3339(UTC);金额单位为分。
写操作成功回 200/201/204;重复提交按资源唯一键回 409。
返回与错误
成功直接回资源 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"
}接口分组与资源
18 个分组,
18 个分组,
490 个接口。
按分组浏览各类资源,点开任一资源查看它的接口、字段与调用示例。
运维与系统8 类资源 · 19 个接口
健康检查
health无需认证的存活探针;业务库不可用时回 503。1 个接口授权license当前安装的授权状态与有效期;过期锁定后不能新增站点、转发、节点等。1 个接口IP 归属地库geoip主控在用的 IP 归属地库(服务商下发 > 内置)、节点对齐进度与地址查询。2 个接口区域/节点黑名单guard-blacklists按区域或主节点导入的防火墙黑名单文件(每份上限 100 万条),单独成文件下发给节点,不进全局快照。4 个接口WAF 规则库waf-rules主控下发的 WAF 规则包版本、各节点对齐情况与防护清单(付费功能 rules_update;没开通时节点用内置 23 条)。2 个接口用户级默认配置user-defaults新建站点或四层转发时带入的默认字段,按类型分别保存。3 个接口后台任务tasks异步操作的任务队列;可查看、取消待执行任务、重试失败任务。2 个接口日志审计audit只读的登录日志、操作日志、节点 IP 切换日志与消息发送日志,可按用户、时间等条件过滤。4 个接口登录认证1 类资源 · 1 个接口
用户账号4 类资源 · 23 个接口
支付与账户8 类资源 · 26 个接口
我的账户
account当前用户自己的余额与冻结状态;管理员改用户账户走用户管理下的账户接口。2 个接口订单orders充值、扣款、在线支付与套餐购买产生的订单;租户只见本租户,管理员可跨租户,订单只许改备注。4 个接口账户流水ledger-entries账户余额的每一笔变动,每条带记账后的余额快照。1 个接口在线支付payments发起在线充值:建一张待支付订单并向支付网关预下单,返回付款地址。3 个接口充值方式payment-methods当前可用的在线支付方式、默认方式与转账说明,充值页据此渲染。1 个接口支付通道payment-channels管理员配置支付方式走哪家网关及各网关商户参数;密钥只写不回显。3 个接口USDT 到账usdt-transfers链上转入 USDT 收款地址的逐笔记录;对不上订单的由管理员补入或忽略。3 个接口货币设置settings管理员维护货币表(启用、汇率、取整)、基准货币与新用户默认;老版本升级后确认升级前的记账货币。9 个接口DNS 与接入4 类资源 · 23 个接口
节点调度10 类资源 · 38 个接口
区域
regions节点所属的地理区域,用于给节点和节点组归类。5 个接口节点nodes已审核的边缘节点与子 IP;主节点经注册令牌自助注册,子 IP 由管理员手工添加。10 个接口待接入节点pending-nodes已用令牌注册、等待管理员审核的节点;审核通过后成为正式节点。3 个接口节点接入令牌node-enroll-tokens生成一次性注册令牌与节点一行安装命令,并可按 id 查令牌是否已被节点用掉;令牌原文只在生成时返回一次。2 个接口节点分组node-groups把线路编成组并对应一个接入名;可设置备用阈值,可用线路不足时自动切到备用组。9 个接口线路lines节点组里的一条解析记录:节点按哪条 DNS 解析线路、多少权重出现在组里;删除前须先停用。5 个接口节点线路地区标签node-line-tags每个主节点挑一个接入根域与该域名下的若干线路;设置解析时按当前线路默认勾选带该线路标签的节点。1 个接口告警规则alert-rules主控内置的统一告警规则及其当前设置与状态;阈值通过系统设置修改。1 个接口告警记录alerts最近的告警与恢复记录,保留 30 天。1 个接口节点监控日志monitor-logs主控对开启监控的节点 IP 每轮探测的结果记录。1 个接口IP 产品线2 类资源 · 20 个接口
证书6 类资源 · 31 个接口
证书
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 个接口防护22 类资源 · 85 个接口
访问控制(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 管理:按六类(搜索引擎 / 监控·工具 / 自动化工具 / AI 爬虫 / 无头浏览器 / 恶意 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 规则更新,每小时同步)的状态、全局处置策略、条目查询、单条加白与今日来访命中;租户只读。7 个接口增值防护方案protect-schemes防重放、防泄露、防篡改各一份方案(租户各自一份,管理员编辑平台方案);保存时一并改「按方案」的站点,单独设置的不动;属 WAF 增强。10 个接口防重放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 个接口套餐7 类资源 · 40 个接口
套餐
packages可售卖的基础套餐,定义流量、带宽、域名数等额度与价格。8 个接口套餐分组package-groups把套餐分组展示,便于客户选购。6 个接口扩展包package-upgrades在基础套餐之上按份加购的额度或功能。5 个接口套餐目录package-catalog客户可购买的套餐、分组与扩展包目录。1 个接口已购套餐user-packages租户已购买的套餐:购买、续费、更换、加购扩展包与用量查看。17 个接口已售套餐用户user-package-owners仅管理员:按用户归组的已售套餐列表(套餐数、到期统计、页签计数)。1 个接口套餐监控package-monitor仅管理员:近 1 分钟各用户套餐的带宽与连接数。2 个接口网站2 类资源 · 35 个接口
缓存6 类资源 · 21 个接口
缓存分组
cache-groups一组缓存规则,可供多个站点引用;分平台分组与租户自建分组。7 个接口缓存策略cache-policy设置本租户的默认缓存分组,并可把全部站点改回按默认分组。4 个接口缓存标配cache-presets出厂标配缓存规则,可作为新建缓存分组的参考。1 个接口站点缓存分组与本站改动cache-sites查看或设置单个站点使用的缓存分组与本站改动(新增 / 修改 / 删除规则、忽略参数清单)。5 个接口刷新与预热cache-jobs刷新(清除)缓存的 URL 或目录,以及预热指定 URL。3 个接口刷新预热限额cache-quota每日刷新与预热的限额及今日已用量。1 个接口