diff --git a/docs/config/api.md b/docs/config/api.md index ed1916f0d..0b3e88a97 100644 --- a/docs/config/api.md +++ b/docs/config/api.md @@ -2,9 +2,9 @@ API 接口配置提供了一些基于 [gRPC](https://grpc.io/)的 API 接口供远程调用。 -可以通过 api 配置模块开启接口. 当 api 配置开启时,Xray 会自建一个出站代理,须手动将所有的 API 入站连接通过 [路由规则配置](./routing.md) 指向这一出站代理。 +可以通过 api 配置模块开启接口。当 api 配置开启时,Xray 会自建一个和 tag 同名的出站代理,须手动将所有的 API 入站连接通过 [路由规则配置](./routing.md) 指向这一出站代理。请参考本节中的 [相关配置](#相关配置)。 -请参考本节中的 [相关配置](#相关配置) +[v1.8.12](https://github.com/XTLS/Xray-core/releases/tag/v1.8.12) 起支持简易配置模式,只配置 ApiObject 即可,不需要配置 inbounds 和 routing。但是使用简易配置时,流量统计功能不统计 API 入站连接的流量。 ::: warning 大多数用户并不会用到此 API,新手可以直接忽略这一项。 @@ -18,7 +18,8 @@ API 接口配置提供了一些基于 [gRPC](https://grpc.io/)的 API 接口供 { "api": { "tag": "api", - "services": ["HandlerService", "LoggerService", "StatsService"] + "listen": "127.0.0.1:8080", + "services": ["HandlerService", "LoggerService", "StatsService", "RoutingService"] } } ``` @@ -27,6 +28,12 @@ API 接口配置提供了一些基于 [gRPC](https://grpc.io/)的 API 接口供 出站代理标识。 +> `listen`: string + +API 服务监听的 IP 和端口。这是一个可选配置项。 + +省略这项时需要按照下面[相关配置](#相关配置)中的示例,添加 inbounds 和 routing 配置。 + > `services`: \[string\] 开启的 API 列表,可选的值见 [API 列表](#支持的-api-列表)。 @@ -89,6 +96,18 @@ API 接口配置提供了一些基于 [gRPC](https://grpc.io/)的 API 接口供 - 在一个入站代理中添加一个用户(仅支持 VMess、VLESS、Trojan、Shadowsocks(v1.3.0+)); - 在一个入站代理中删除一个用户(仅支持 VMess、VLESS、Trojan、Shadowsocks(v1.3.0+)); +### RoutingService + +添加、删除、替换 routing 规则,查询均衡器统计信息的 API,可用的功能如下: + +- adrules 添加、替换 routing 配置 +- rmrules 删除 routing 规则 +- sib 断开来源 IP 的连接 +- bi 查询均衡器统计信息 +- bo 强制均衡器选中指定的 outboundTag + +可以使用类似于 `./xray help api bi` 这样的命令来查询具体用法。 + ### LoggerService 支持对内置 Logger 的重启,可配合 logrotate 进行一些对日志文件的操作。