旧版行为与适用边界
旧配置中的功能限制与内核代际有关。迁移到其他实现时,应重新确认字段支持情况;旧版的能力边界不能直接套用到正在运行的软件。
控制入口概览
图形控制界面可以通过 HTTP RESTful API 与运行中的程序交互。在 external-controller 填写监听地址后,即可启用控制入口。
请求身份验证
- 访问控制入口时,使用
Bearer Tokens验证请求身份。- 请求头应写为
Authorization: Bearer <Your Secret>,把访问凭证随请求一并传入。
- 请求头应写为
RESTful API 接口索引
日志读取
/logs- 方法:
GET- 完整路径:
GET /logs - 用途:读取运行期间产生的日志。
- 完整路径:
- 方法:
流量信息
/traffic- 方法:
GET- 完整路径:
GET /traffic - 用途:读取当前流量信息。
- 完整路径:
- 方法:
版本信息
/version- 方法:
GET- 完整路径:
GET /version - 用途:查询内核版本信息。
- 完整路径:
- 方法:
配置操作
/configs方法:
GET- 完整路径:
GET /configs - 用途:查看基础配置内容。
- 完整路径:
方法:
PUT- 完整路径:
PUT /configs - 用途:从文件重新载入配置。
- 完整路径:
方法:
PATCH- 完整路径:
PATCH /configs - 用途:提交需要调整的配置字段。
- 完整路径:
出口信息
/proxies- 方法:
GET- 完整路径:
GET /proxies - 用途:列出各个代理出口的信息。
- 完整路径:
- 方法:
/proxies/:name方法:
GET- 完整路径:
GET /proxies/:name - 用途:查看名称对应的出口信息。
- 完整路径:
方法:
PUT- 完整路径:
PUT /proxies/:name - 用途:更改手动选择组正在使用的出口。
- 完整路径:
/proxies/:name/delay- 方法:
GET- 完整路径:
GET /proxies/:name/delay - 用途:请求指定出口的延迟检查信息。
- 完整路径:
- 方法:
分流条件
/rules- 方法:
GET- 完整路径:
GET /rules - 用途:列出已载入的分流规则。
- 完整路径:
- 方法:
连接管理
/connections方法:
GET- 完整路径:
GET /connections - 用途:查看正在处理的连接。
- 完整路径:
方法:
DELETE- 完整路径:
DELETE /connections - 用途:结束当前全部连接。
- 完整路径:
/connections/:id- 方法:
DELETE- 完整路径:
DELETE /connections/:id - 用途:结束标识符对应的连接。
- 完整路径:
- 方法:
代理集合
/providers/proxies- 方法:
GET- 完整路径:
GET /providers/proxies - 用途:列出各代理集合中的出口信息。
- 完整路径:
- 方法:
/providers/proxies/:name方法:
GET- 完整路径:
GET /providers/proxies/:name - 用途:查看名称对应的代理集合。
- 完整路径:
方法:
PUT- 完整路径:
PUT /providers/proxies/:name - 用途:刷新名称对应的代理集合。
- 完整路径:
/providers/proxies/:name/healthcheck- 方法:
GET- 完整路径:
GET /providers/proxies/:name/healthcheck - 用途:读取该代理集合的出口信息。
- 完整路径:
- 方法:
DNS 解析请求
/dns/query方法:
GET完整路径:
GET /dns/query?name={name}[&type={type}]用途:按名称及记录类型查询解析结果。
参数:
name是必填的目标域名;type用来选择记录类型,例如 A、MX 或 CNAME。省略时使用A记录。
示例:
GET /dns/query?name=example.com&type=A
