API说明 - misakanetwork2018/ss-libev-mu GitHub Wiki

该项目提供一个 Gin HTTP 服务器,因此向服务器发起指定请求可以代理操作ss-manager,这也是本项目的目的

添加端口

  • 路径: /add
  • 方法: POST
  • 参数如下
参数名 类型 是否必须 说明
port int 端口
pass string 密码
method string 加密方式
fast_open bool 不清楚留空或false
mode string 端口模式,可选tcp/udp/tcp_and_udp,留空默认tcp_and_udp
plugin string 插件,不清楚留空
plugin_opts string 插件参数,不清楚留空
  • 返回值示例
{
    "msg": "",
    "success": true
}

删除端口

  • 路径: /del
  • 方法: POST
  • 参数如下
参数名 类型 是否必须 说明
port int 端口
  • 返回值示例
{
    "msg": "",
    "success": true,
    "transfer": 0
}

特别说明:每次删除端口时都会返回最后一次递增流量,且流量会被重置,因此执行流量统计时请务必调用该接口然后重建端口

端口信息列表

  • 路径: /list
  • 方法: GET
  • 返回值示例
{
    "data": [
        {
            "server_port": "8888",
            "password": "123456",
            "method": "aes-128-gcm"
        }
    ],
    "success": true
}

特别说明:该列表只展示服务器端口、密码以及加密方式这三种信息,其他信息不会显示,但不代表没有设置其他信息!

端口流量列表

  • 路径: /traffic
  • 方法: GET
  • 返回值示例
{
    "data": {
        "8888": 0
    },
    "success": true
}

特别说明:严格意义上来说这是键值对而不是list,通过该接口获取的流量为递增流量,但建议一段时间后重建端口以真正重置流量。

服务器信息

  • 路径: /status
  • 方法: GET
  • 返回值示例
{
    "data": {
        "loadavg": "0.05 0.14 0.18 1/679 3878",
        "uptime": "2209.95"
    },
    "success": true
}

传统艺能了,这个没什么好说的

重启

  • 路径: /reboot
  • 方法: POST
  • 返回值示例
{
    "msg": "",
    "success": true
}

特别说明:该接口仅用于systemd下管理的进程,若非systemd管理,则重启会失败。重启需要root权限(若为系统进程),否则会失败。重启会导致流量信息丢失,请谨慎操作!