V2Fly.orgV2Fly.org
快速开始
配置文档
配置文档 (v5, WIP)
工具列表
开发手册
新白话文指南
  • 简体中文
  • English
GitHub
快速开始
配置文档
配置文档 (v5, WIP)
工具列表
开发手册
新白话文指南
  • 简体中文
  • English
GitHub
  • 配置文件

    • 配置文件格式
    • 环境变量
    • DNS 域名解析
    • Routing 路由
    • Policy 本地策略
    • Inbounds
    • Outbounds
    • Transport
    • API 远程控制
      • ApiObject
      • 支持的 API 列表
        • HandlerService
        • LoggerService
        • StatsService
        • ObservatoryService
    • Stats 统计信息
    • Reverse 反向代理
    • 多文件配置
    • FakeDNS
    • 浏览器转发模块
    • Observatory 连接观测
  • 协议列表

    • Blackhole
    • DNS
    • Dokodemo-door
    • Freedom
    • HTTP
    • Socks
    • VMess
    • Shadowsocks
    • Trojan
    • VLESS
    • Loopback
    • Hysteria2
  • 传输方式

    • TCP
    • mKCP
    • WebSocket
    • HTTP/2
    • QUIC
    • DomainSocket
    • gRPC
    • Hysteria2
  • 服务

    • Stats 统计信息
    • Policy 本地策略
    • 浏览器转发模块
    • 并发连接观测
    • 后台连接观测
    • Tun
    • 订阅管理器

API 远程控制

V2Ray 中可以开放一些 API 以便远程调用。这些 API 都基于 gRPC。大多数用户并不会用到此 API,新手可以直接忽略这一项。

当远程控制开启时,V2Ray 会自建一个出站代理,以 tag 配置的值为标识。用户必须手动将所有的 gRPC 入站连接通过 路由 指向这一出站代理。

ApiObject

ApiObject 对应配置文件的 api 项。

{
    "tag": "api",
    "services": [
        "HandlerService",
        "LoggerService",
        "StatsService"
    ]
}

tag: string

出站代理标识。

services: [string]

开启的 API 列表,可选的值见 API 列表。

支持的 API 列表

HandlerService

一些对于入站出站代理进行修改的 API,可用的功能如下:

  • 添加一个新的入站代理;
  • 添加一个新的出站代理;
  • 删除一个现有的入站代理;
  • 删除一个现有的出站代理;
  • 在一个入站代理中添加一个用户(仅支持 VMess、VLESS、Trojan);
  • 在一个入站代理中删除一个用户(仅支持 VMess、VLESS、Trojan);

LoggerService

支持对内置 Logger 的重启,可配合 logrotate 进行一些对日志文件的操作。

StatsService

内置的数据统计服务,详见 统计信息。

ObservatoryService

连接观测 组件 API (v4.38.0+) 。

在 GitHub 上编辑此页
上次更新:
贡献者: kslr, EpLiar, RPRX, Kslr, Shelikhoo
Prev
Transport
Next
Stats 统计信息