版本 2.4.7.20261116085428 · 最新

节点 nodes

已审核的边缘节点与子 IP;主节点经注册令牌自助注册,子 IP 由管理员手工添加。

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

节点调度鉴权: 仅管理员10 个接口

鉴权

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

鉴权: 仅管理员

查询参数

字段类型说明
pageinteger 页码,从 1 开始。
默认 1
page_sizeinteger 每页条数。
默认 20
sortstring 排序字段,逗号分隔,前缀 `-` 表示降序,如 `-created_at,id`。
POST/api/v2/nodes创建节点

鉴权: 仅管理员

请求体 application/json

字段类型说明
areastring 地区(只做展示,不下发节点);空 = 未填。子 IP 取主节点的。
bandwidth_mbpsinteger 节点带宽 Mbps(只做展示,与 monitor.bw_limit_mbps 无关);0 = 未填。子 IP 取主节点的。
desstring 备注说明
enabledboolean 是否启用
ipstring 节点 IP 地址(IPv4 或 IPv6)。
monitorNodeMonitor 节点监控探测设置(主控按 monitor.node 配置的间隔探这个 IP)。
name必填string 名称
parent_idinteger 子 IP 所属主节点;null = 主节点。
region_idinteger 区域 ID
service_expirestring 服务器到期日 YYYY-MM-DD(首页到期提醒用,不自动停用);null = 未填、不提醒。子 IP 取主节点的。
service_startstring 服务器开始日 YYYY-MM-DD(只做展示);null = 未填。子 IP 取主节点的。
GET/api/v2/nodes/{id}获取节点

鉴权: 仅管理员

查询参数

字段类型说明
capacityboolean 为 true 时附带 capacity(主节点才有;没有系统信息时为 null)。
PUT/api/v2/nodes/{id}修改节点

鉴权: 仅管理员

请求体 application/json

字段类型说明
areastring 地区(只做展示,不下发节点);空 = 未填。子 IP 取主节点的。
bandwidth_mbpsinteger 节点带宽 Mbps(只做展示,与 monitor.bw_limit_mbps 无关);0 = 未填。子 IP 取主节点的。
desstring 备注说明
enabledboolean 是否启用
expected_updated_atstring 乐观锁(修改时用):调用方读到的该资源 updated_at。与库里当前值不等则回 409 stale_version、不保存;不带则不检查。心跳不改 updated_at;监控自动启停、HTTP/3 与 TFO 探测自动关开、L2 设置/移除、替换节点等也会改。
ipstring 节点 IP 地址(IPv4 或 IPv6)。
monitorNodeMonitor 节点监控探测设置(主控按 monitor.node 配置的间隔探这个 IP)。
namestring 名称
parent_idinteger 子 IP 所属主节点;null = 主节点。
region_idinteger 区域 ID
service_expirestring 服务器到期日 YYYY-MM-DD(首页到期提醒用,不自动停用);null = 未填、不提醒。子 IP 取主节点的。
service_startstring 服务器开始日 YYYY-MM-DD(只做展示);null = 未填。子 IP 取主节点的。
POST/api/v2/nodes/{id}/config-readmit重新下发被节点回滚的配置

鉴权: 仅管理员

PUT/api/v2/nodes/{id}/line-tags设置节点线路地区标签

鉴权: 仅管理员

请求体 application/json

字段类型说明
domain_id必填integer 接入根域 id;0 = 清掉标签。
lines必填string[] 统一线路代号,取自该域名的线路选项。
POST/api/v2/nodes/{id}/revoke-cert吊销节点当前证书

鉴权: 仅管理员

POST/api/v2/nodes/{id}/to-pending节点移回待初始化

鉴权: 仅管理员

节点对象

字段类型说明
areastring 地区(只做展示,不下发节点);空 = 未填。子 IP 取主节点的。
bandwidth_mbpsinteger 节点带宽 Mbps(只做展示,与 monitor.bw_limit_mbps 无关);0 = 未填。子 IP 取主节点的。
capacityNodeCapacity 节点内存容量(只读,只在 GET /nodes/{id}?capacity=true 给出):单站常驻 = location 数 × 28.1KB + https 占比 × 25.5KB,预算 = 内存 MiB × 0.25 / 2 − 28MiB,上限 = 预算 / 单站。null = 没有该节点的系统信息或缺内存总量。
只读
cert_expirystring 最近一次签发证书的到期时刻;null = 还没领过证(或子 IP)。
created_atstring 创建时间
只读
desstring 备注说明
disable_bystring 停用来源(manual = 管理员;monitor = 节点监控自动停用,探测恢复后自动启用;bandwidth = 出站带宽超过 monitor.bw_limit_mbps 自动停用,回落后自动启用;license = 服务商吊销授权;trial = 试用结束,节点停止服务,购买后自动恢复;drain = 节点升级重启 nginx 前主动申请摘出解析,自检通过后自动加回,超时由主控收回);启用时为空。
domainstring 接入根域;没有标签为空。
domain_id必填integer 接入根域 id;0 = 清掉标签。
enabledboolean 是否启用
enrolled_atstring 节点注册时刻;手工添加的子 IP 为 null。
expected_updated_atstring 乐观锁(修改时用):调用方读到的该资源 updated_at。与库里当前值不等则回 409 stale_version、不保存;不带则不检查。心跳不改 updated_at;监控自动启停、HTTP/3 与 TFO 探测自动关开、L2 设置/移除、替换节点等也会改。
hintsstring[] 提示(如取不到网卡地址)。
hostnamestring 节点主机名,注册时上报。
idinteger 记录 ID
只读
ipstring 节点 IP 地址(IPv4 或 IPv6)。
lines必填string[] 统一线路代号,取自该域名的线路选项。
monitorNodeMonitor 节点监控探测设置(主控按 monitor.node 配置的间隔探这个 IP)。
namestring 名称
node_idinteger 主节点 id(子 IP 的标签存在主节点上)。
opsNodeOps 节点运维状态(只读,来自心跳):在线、配置是否落后于最新已发布版本、时钟是否同步。子 IP 跟随主节点。
只读
parent_idinteger 子 IP 所属主节点;null = 主节点。
region_idinteger 区域 ID
rolestring 节点角色:edge 边缘节点;l2 二级缓存节点。
可选值 ["edge","l2"]
service_expirestring 服务器到期日 YYYY-MM-DD(首页到期提醒用,不自动停用);null = 未填、不提醒。子 IP 取主节点的。
service_startstring 服务器开始日 YYYY-MM-DD(只做展示);null = 未填。子 IP 取主节点的。
statusstring ok = 有结果;pending = 已排指令,稍后再取;unknown = 节点不在线。
可选值 ["ok","pending","unknown"]
updated_atstring 更新时间
只读
v4string[] 节点网卡上的 IPv4 地址。
v6string[] 节点网卡上的 IPv6 地址。

返回与错误

成功直接回资源 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