nps/docs/webapi.md
avengexyz c595db19b9
添加了25.4版本webapi参数说明
自己测试的25.4版本
webapi 需要的参数
2020-01-05 22:20:55 +08:00

5.2 KiB
Raw Blame History

获取客户端列表

url='http://你的域名或者网址/client/list/';

post提交的数据

参数 含义
search 搜索
order 排序asc 正序 desc倒序
offset 分页(第几页)
limit 条数(分页显示的条数)

获取单个客户端

url='http://你的域名或者网址/client/getclient/';

post提交的数据

参数 含义
id 客户端id

添加客户端

url='http://你的域名或者网址/client/add/';

post提交的数据

参数 含义
remark 备注
u basic权限认证用户名
p basic权限认证密码
limit 条数(分页显示的条数)
vkey 客户端验证密钥
config_conn_allow 是否允许客户端以配置文件模式连接 1允许 0不允许
compress 压缩1允许 0不允许
crypt 是否加密1或者01允许 0不允许
rate_limit 带宽限制 单位KB/S 空则为不限制
flow_limit 流量限制 单位M 空则为不限制
max_conn 客户端最大连接数量 空则为不限制
max_tunnel 客户端最大隧道数量 空则为不限制

修改客户端(25.4版本有问题暂时不能用)

url='http://你的域名或者网址/client/edit/';

post提交的数据

参数 含义
remark 备注
u basic权限认证用户名
p basic权限认证密码
limit 条数(分页显示的条数)
vkey 客户端验证密钥
config_conn_allow 是否允许客户端以配置文件模式连接 1允许 0不允许
compress 压缩1允许 0不允许
crypt 是否加密1或者01允许 0不允许
rate_limit 带宽限制 单位KB/S 空则为不限制
flow_limit 流量限制 单位M 空则为不限制
max_conn 客户端最大连接数量 空则为不限制
max_tunnel 客户端最大隧道数量 空则为不限制
id 要修改的客户端id

删除客户端

url='http://你的域名或者网址/client/del/';

post提交的数据

参数 含义
id 要删除的客户端id

获取域名解析列表

url='http://你的域名或者网址/index/hostlist/';

post提交的数据

参数 含义
search 搜索(可以搜域名/备注什么的)
offset 分页(第几页)
limit 条数(分页显示的条数)

添加域名解析

url='http://你的域名或者网址/index/addhost/';

post提交的数据

参数 含义
remark 备注
host 域名
scheme 协议类型(三种 all http https)
location url路由 空则为不限制
client_id 客户端id
target 内网目标(ip:端口)
header request header 请求头
hostchange request host 请求主机

修改域名解析

url='http://你的域名或者网址/index/edithost/';

post提交的数据

参数 含义
remark 备注
host 域名
scheme 协议类型(三种 all http https)
location url路由 空则为不限制
client_id 客户端id
target 内网目标(ip:端口)
header request header 请求头
hostchange request host 请求主机
id 需要修改的域名解析id

删除域名解析

url='http://你的域名或者网址/index/delhost/';

post提交的数据

参数 含义
id 需要删除的域名解析id

获取单条隧道信息

url='http://你的域名或者网址/index/getonetunnel/';

post提交的数据

参数 含义
id 隧道的id

获取隧道列表

url='http://你的域名或者网址/index/gettunnel/';

post提交的数据

参数 含义
client_id 穿透隧道的客户端id
type 类型tcp udp httpProx socks5 secret p2p
search 搜索
offset 分页(第几页)
limit 条数(分页显示的条数)

添加隧道

url='http://你的域名或者网址/index/add/';

post提交的数据

参数 含义
type 类型tcp udp httpProx socks5 secret p2p
remark 备注
port 服务端端口
target 目标(ip:端口)
client_id 客户端id

修改隧道

url='http://你的域名或者网址/index/edit/';


post提交的数据

参数 含义
type 类型tcp udp httpProx socks5 secret p2p
remark 备注
port 服务端端口
target 目标(ip:端口)
client_id 客户端id
id 隧道id

删除隧道

url='http://你的域名或者网址/index/del/';

post提交的数据

参数 含义
id 隧道id

隧道停止工作

url='http://你的域名或者网址/index/stop/';

post提交的数据

参数 含义
id 隧道id

隧道开始工作

url='http://你的域名或者网址/index/start/';

post提交的数据

参数 含义
id 隧道id