版本 2.4.7.20261116085428 · 最新

线路 lines

节点组里的一条解析记录:节点按哪条 DNS 解析线路、多少权重出现在组里;删除前须先停用。

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

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

鉴权

请求头带 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/lines列出线路

鉴权: 仅管理员

查询参数

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

鉴权: 仅管理员

请求体 application/json

字段类型说明
dns_linestring DNS 解析线路代码(default = 默认线路;运营商/地区线路代码由 DNS 域映射)。
enabledboolean 是否启用
forceboolean 强制写入,跳过两道保护(须二次确认):线路成为启用的主线路时节点须已装上配置、比该装的版本落后不超过 1 版(否则 422 node_config_behind);停用或转备用组里最后一条启用的主线路(否则 422 last_primary_line)。
is_backupboolean 备用 IP:平时不进解析,按节点组的备用 IP 切换方式自动启用/撤下。
is_backup_defaultboolean 默认线路兜底:节点组的默认线路没有可用 IP 时,这条线路的 IP 自动改按默认线路解析(原线路暂停用这个 IP),默认线路恢复后改回原线路。
node_group_id必填integer 所属节点组的 id。
node_id必填integer 节点 ID
weightinteger 权重,1 到 100,越大分到的解析越多。
GET/api/v2/lines/{id}获取线路

鉴权: 仅管理员

PUT/api/v2/lines/{id}修改线路

鉴权: 仅管理员

请求体 application/json

字段类型说明
dns_linestring DNS 解析线路代码(default = 默认线路;运营商/地区线路代码由 DNS 域映射)。
enabledboolean 是否启用
expected_updated_atstring 乐观锁(修改时用):调用方读到的该资源 updated_at。与库里当前值不等则回 409 stale_version、不保存;不带则不检查。定时任务启用/撤下备用 IP、默认线路兜底与监控启停也会改 updated_at。
forceboolean 强制写入,跳过两道保护(须二次确认):线路成为启用的主线路时节点须已装上配置、比该装的版本落后不超过 1 版(否则 422 node_config_behind);停用或转备用组里最后一条启用的主线路(否则 422 last_primary_line)。
is_backupboolean 备用 IP:平时不进解析,按节点组的备用 IP 切换方式自动启用/撤下。
is_backup_defaultboolean 默认线路兜底:节点组的默认线路没有可用 IP 时,这条线路的 IP 自动改按默认线路解析(原线路暂停用这个 IP),默认线路恢复后改回原线路。
node_group_idinteger 所属节点组的 id。
node_idinteger 节点 ID
weightinteger 权重,1 到 100,越大分到的解析越多。

线路对象

字段类型说明
backup_default_onboolean 默认线路兜底使用中、正按默认线路解析(只读,由定时任务维护)。
只读
backup_onboolean 备用 IP 当前已启用进解析(只读,由定时任务维护)。
只读
created_atstring 创建时间
只读
disable_bystring 停用来源(manual 管理员手工、monitor 节点监控、bandwidth 带宽超限、license 服务商吊销授权、trial 试用结束、drain 节点重启前主动摘除等);启用时为空。
dns_linestring DNS 解析线路代码(default = 默认线路;运营商/地区线路代码由 DNS 域映射)。
enabledboolean 是否启用
expected_updated_atstring 乐观锁(修改时用):调用方读到的该资源 updated_at。与库里当前值不等则回 409 stale_version、不保存;不带则不检查。定时任务启用/撤下备用 IP、默认线路兜底与监控启停也会改 updated_at。
forceboolean 强制写入,跳过两道保护(须二次确认):线路成为启用的主线路时节点须已装上配置、比该装的版本落后不超过 1 版(否则 422 node_config_behind);停用或转备用组里最后一条启用的主线路(否则 422 last_primary_line)。
idinteger 记录 ID
只读
is_backupboolean 备用 IP:平时不进解析,按节点组的备用 IP 切换方式自动启用/撤下。
is_backup_defaultboolean 默认线路兜底:节点组的默认线路没有可用 IP 时,这条线路的 IP 自动改按默认线路解析(原线路暂停用这个 IP),默认线路恢复后改回原线路。
node_group_idinteger 所属节点组的 id。
node_idinteger 节点 ID
updated_atstring 更新时间
只读
weightinteger 权重,1 到 100,越大分到的解析越多。

返回与错误

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