外部控制设置
简介
外部控制允许用户通过 HTTP RESTful API 来控制 Clash. 第三方 Clash GUI 就是基于这个功能的. 通过在 external-controller 中指定地址来启用这个功能.
认证
外部控制器接受
Bearer Tokens作为访问认证方式.使用
Authorization: Bearer <Your Secret>作为请求头来传递凭证.
RESTful API 文档
日志
/logs方法:
GET完整路径:
GET /logs描述: 获取实时日志
流量
/traffic方法:
GET完整路径:
GET /traffic描述: 获取实时流量数据
版本
/version方法:
GET完整路径:
GET /version描述: 获取 Clash 版本
配置
/configs方法:
GET完整路径:
GET /configs描述: 获取基础配置
方法:
PUT完整路径:
PUT /configs描述: 重新加载配置文件
方法:
PATCH完整路径:
PATCH /configs描述: 增量修改配置
节点
/proxies方法:
GET完整路径:
GET /proxies描述: 获取所有节点信息
/proxies/:name方法:
GET完整路径:
GET /proxies/:name描述: 获取指定节点信息
方法:
PUT完整路径:
PUT /proxies/:name描述: 切换 Selector 中选中的节点
/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}]描述: 获取指定域名和类型的 DNS 查询数据
参数:
name(必填): 要查询的域名type(可选): 要查询的 DNS 记录类型 (例如, A, MX, CNAME 等). 如果未提供, 则默认为A.
示例:
GET /dns/query?name=example.com&type=A