![]() | 无忧加速器 |
1、概述
概述
无忧IP客户端8.0版本接口说明文档
接口地址
默认地址
http://127.0.0.1:54321 其中端口是基于54321起始,如果端口被占用,则会基于此端口 + 1,最大到 54331
文档版本
20230425
更新日志
20220418 1、新增获取用户唯一ID接口文档说明 2、新增获取客户端版本号接口 3、优化单条节点切换接口,请求限制调整为每条限制 4、优化文档结构,标记各个接口适配版本号 5、客户端 windows 7 版本,增加接口支持
20220415 1、新增接口和优化文档说明
20220406 1、v1接口正式版本发布
20220504 1、增加设置DNS代理开关接口 2、增加设置上号顺序方式接口 3、增加设置是否启用始终从可用节点开始代理接口
20220507 1、增加设置开启(关闭)开机自启 2、增加设置开启(关闭)登录成功后自动最小化 3、增加设置开启(关闭)随机进程名 4、增加设置开启(关闭)性能优化 5、增加设置开启(关闭)节点切换保护 6、增加设置开启(关闭)禁用本地
20220517 1、增加结束所有已代理的进程 2、增加设置开启(关闭)节点无网自动切换
20220530 1、增加设置开启(关闭)节点到期提醒开关 2、增加设置开启(关闭)节点状态ping检测 3、增加结束指定节点已代理的所有进程
20220616 1、增加请求切换所有节点
20220624 1、增加退出无忧IP客户端,支持命令行参数调用 2、结束所有已代理的进程,增加支持命令行参数调用 3、请求切换所有节点,增加支持命令行参数调用
20221215 1、增加设置指定节点代理进程功能
20230425 1、增加设置节点绑定开关 2、增加设置节点禁止重复绑定开关 3、增加设置节点区分模拟器绑定开关 4、增加读取绑定数据列表
2、标准数据返回格式
{
//本次请求接口名称
"action": "v1/nodeNetworkDetection",
//返回的消息内容,只有当result不等于0的情况下才会返回,一般用于错误消息
"message": "",
//接口执行结果,0表示成功,非0为错误代码
"result": 0,
//请求时间
"timestamp": "2022-04-01 16:50:57",
//返回的关联数据,依据不同接口返回不同数据结果集
"data": {
"HttpRequestTime": 195
}
}
3、获取用户唯一id
简要描述
请求切换节点
适配版本
8.0.0.220406 及以上
请求URL
http://127.0.0.1:54321/api/v1/getUserIdentitySessionId
请求方式
GET
请求示例
http://127.0.0.1:54321/api/v1/getUserIdentitySessionId
返回示例
{
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"message": "",
//用户唯一id
"data": "d0970714757783e6cf17b26fb8e2298f"
}
返回参数说明
参数名
类型
说明
备注
更多返回错误代码请看首页的错误代码描述
4、获取当前本机已分配的节点列表数据
简要描述
获取当前本机已分配的节点列表数据
适配版本
8.0.0.220406 及以上
请求URL
http://127.0.0.1:54321/api/v1/getAllotNodeList
请求方式
GET
请求示例
http://127.0.0.1:54321/api/v1/getAllotNodeList
返回示例
{
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"data": [
{
//节点类型,01=静态、02=动态、03=全国(全国动态)
"type": "动态",
//节点序号
"order": 1,
//节点编号
"number": "jj0001",
//地区名称
"regionName": "九江电信",
//项目名称
"itemName": "魔兽世界全服",
//剩余到期时间(分钟)
"expire": 123456,
//分配窗口数
"allot": 2,
//上号(代理)窗口数
"proxy": 0
}
]
}
备注
更多返回错误代码请看错误代码描述
5、请求切换节点
简要描述
请求切换节点
适配版本
8.0.0.220406 及以上
接口请求限制规则优化适配 8.0.0.220418 及以上
请求URL
http://127.0.0.1:54321/api/v1/nodeRequestSwitch
请求方式
GET
请求参数
参数名
必选
类型
说明
nodeOrder
是
int
需要请求切换的节点序号
请求示例
http://127.0.0.1:54321/api/v1/nodeRequestSwitch?nodeOrder=1
返回示例
{
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"message": ""
}
返回参数说明
参数名
类型
说明
备注
更多返回错误代码请看首页的错误代码描述
更新日志
20220418,优化节点请求时间限制,全局限制改为单条节点限制
6、批量请求切换节点
简要描述
请求切换节点
适配版本
8.0.0.220406 及以上
请求URL
http://127.0.0.1:54321/api/v1/nodeBatchRequestSwitch
请求方式
GET
请求参数
参数名
必选
类型
说明
nodeOrder
是
string
需要请求切换的节点序号,多条节点之间使用英文半角(,)逗号分隔,示例:1,2,3
请求示例
http://127.0.0.1:54321/api/v1/nodeRequestSwitch?nodeOrder=1,2,3
返回示例
{
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"message": ""
}
返回参数说明
参数名
类型
说明
备注
更多返回错误代码请看首页的错误代码描述
7、获取所有已经代理的进程列表
简要描述
获取所有已经代理的进程列表
适配版本
8.0.0.220406 及以上
请求URL
http://127.0.0.1:54321/api/v1/getAllProxyProcessLists
请求方式
GET
请求示例
http://127.0.0.1:54321/api/v1/getAllProxyProcessLists
返回示例
{
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"message": "",
"data": [{
//节点序号
"nodeOrder": 1,
//父进程id
"ppid": 111,
//进程id
"pid": 222,
//进程名称
"name": "a.exe",
//累计发送流量
"flowSend": "123k",
//累计接收流量
"flowReceive": "123k"
}]
}
返回参数说明
参数名
类型
说明
备注
更多返回错误代码请看首页的错误代码描述
8、节点网络检测
简要描述
节点网络检测(推荐使用异步接口,参考提交节点网络检测接口和查询节点网络检测接口)
适配版本
8.0.0.220406 及以上
请求URL
http://127.0.0.1:54321/api/v1/nodeNetworkDetection
请求方式
GET
请求参数
参数名
必选
类型
说明
nodeOrder
是
int
需要检测的节点序号
请求示例
http://127.0.0.1:54321/api/v1/nodeNetworkDetection?nodeOrder=1
返回示例
{
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"message": "",
"data": {
//请求成功数据响应时间ms
"HttpRequestTime": 123
}
}
返回参数说明
参数名
类型
说明
备注
更多返回错误代码请看首页的错误代码描述
9、查询指定进程ID是否已经成功代理
简要描述
查询指定进程ID是否已经成功代理
适配版本
8.0.0.220415 及以上
请求URL
http://127.0.0.1:54321/api/v1/queryProcessIsProxy
请求方式
GET
请求参数
参数名
必选
类型
说明
pid
是
int
进程id
请求示例
http://127.0.0.1:54321/api/v1/queryProcessIsProxy?pid=123
返回示例
{
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"message": "",
"data": {
//节点序号
"nodeOrder": 1,
//进程id
"id": 1234,
//进程名称
"name": "123.exe",
//父进程id
"parentId": 321,
//父进程名称
"parentName": "abc.exe",
//累计发送流量字节
"sendFlow": 1234,
//累计接收流量字节
"reviceFlow": 1234
}
}
返回参数说明
参数名
类型
说明
备注
更多返回错误代码请看首页的错误代码描述
10、提交节点网络检测
简要描述
提交节点网络检测
适配版本
8.0.0.220415 及以上
请求URL
http://127.0.0.1:54321/api/v1/submitNodeNetworkDetection
请求方式
GET
请求参数
参数名
必选
类型
说明
nodeOrder
是
string
需要请求切换的节点序号,多个之间使用半角英文逗号分隔,例如:1,2,3,4
请求示例
· http://127.0.0.1:54321/api/v1/submitNodeNetworkDetection?nodeOrder=1
http://127.0.0.1:54321/api/v1/submitNodeNetworkDetection?nodeOrder=1,2,3
返回示例
{
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"message": "",
"data": [{
//提交结果,success = 提交成功,waiting = 节点正在执行检测中,failed = 提交失败
"result": "success",
//错误消息,只有当提交结果返回失败的时候有
"message": "",
//节点序号
"nodeOrder": 1,
//请求时间戳,便于对应查询结果,如果返回执行中,则返回的时间戳是上一次提交的时间戳
"timestamp": 1234567890123
}]
}
返回参数说明
参数名
类型
说明
-
-
-
备注
更多返回错误代码请看首页的错误代码描述
11、查询节点网络检测结果
简要描述
提交节点网络检测
适配版本
8.0.0.220415 及以上
请求URL
http://127.0.0.1:54321/api/v1/queryNodeNetworkDetection
请求方式
GET
请求参数
参数名
必选
类型
说明
nodeOrder
是
string
需要查询的节点序号,多个之间使用半角英文逗号分隔,例如:1,2,3,4
请求示例
· http://127.0.0.1:54321/api/v1/queryNodeNetworkDetection?nodeOrder=1
http://127.0.0.1:54321/api/v1/queryNodeNetworkDetection?nodeOrder=1,2,3
返回示例
{
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"message": "",
"data": [{
//查询状态,success = 检测成功,waiting = 执行中,failed = 检测失败
"result": "success",
//节点序号
"nodeOrder": 1,
//请求耗时
"duration": 11,
//请求时间戳,对应最后一次请求的时间戳,如果返回执行中,则返回的时间戳是上一次提交的时间戳
"timestamp": 1234567890123,
//失败的情况下返回的错误消息内容
"message": ""
}]
}
返回参数说明
参数名
类型
说明
-
-
-
备注
更多返回错误代码请看首页的错误代码描述
12、获取客户端版本号
简要描述
请求切换节点
适配版本
8.0.0.220418 及以上
请求URL
http://127.0.0.1:54321/api/v1/getClientVersion
请求方式
GET
请求示例
http://127.0.0.1:54321/api/v1/getClientVersion
返回示例
{
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"message": "",
//客户端版本号,其中 220418 表示 2位年份+月份+日期,如果同一天发布了多次更新,则增加数字表示,如:8.0.0.220418.1
"data": "8.0.0.220418"
}
返回参数说明
参数名
类型
说明
备注
更多返回错误代码请看首页的错误代码描述
13、设置DNS代理开关
简要描述
设置DNS代理开关(开启后,将使用远程节点代理IP解析域名地址)
关闭DNS代理的时候,除了switch请求参数,其它请求参数均视为无效,防止覆盖原来的参数
海外节点,开启DNS代理,请设置DNS服务地址,否则将有可能导致DNS解析失败,最终导致上号失败
注意:仅驱动V5模式下支持
适配版本
8.0.0.220504 及以上
请求URL
http://127.0.0.1:54321/api/v1/setDnsProxySwitch
请求方式
GET
请求参数
参数名
必选
类型
说明
switch
是
int
开关,1=开,0=关
server
否
string
DNS服务地址,默认:114.114.114.114
port
否
int
DNS服务端口,默认:53
请求示例
· http://127.0.0.1:54321/api/v1/setDnsProxySwitch?switch=1
· http://127.0.0.1:54321/api/v1/setDnsProxySwitch?switch=0
· http://127.0.0.1:54321/api/v1/setDnsProxySwitch?switch=1&server=114.114.114.114
http://127.0.0.1:54321/api/v1/setDnsProxySwitch?switch=1&server=114.114.114.114&port=53
返回示例
{
//0=设置成功,大于0表示设置失败,返回的相关错误代码
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"message": "",
"data": ""
}
返回参数说明
参数名
类型
说明
备注
更多返回错误代码请看首页的错误代码描述
14、设置上号顺序方式
简要描述
设置上号顺序方式
每次设置后,将重置上号索引信息,及从第一条节点开始
适配版本
8.0.0.220504 及以上
请求URL
http://127.0.0.1:54321/api/v1/setProxyOrderMode
请求方式
GET
请求参数
参数名
必选
类型
说明
mode
是
string
模式,loop=循环模式 order=顺序模式
· loop,循环模式,依照节点列表循环上号,直至所有分配的窗口上满
order,顺序模式,按照节点列表顺序上号,每条节点分配的窗口上满后再上下一条节点
请求示例
· http://127.0.0.1:54321/api/v1/setProxyOrderMode?mode=loop
http://127.0.0.1:54321/api/v1/setProxyOrderMode?mode=order
返回示例
{
//0=设置成功,大于0表示设置失败,返回的相关错误代码
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"message": "",
"data": ""
}
返回参数说明
参数名
类型
说明
备注
更多返回错误代码请看首页的错误代码描述
15、设置是否启用始终从可用节点开始代理
简要描述
设置是否启用始终从可用节点开始代理
循环代理始终从可用节点开始代理,顺序代理始终从未上满节点开始代理
每次设置后,将重置上号索引信息,及从第一条节点开始
适配版本
8.0.0.220504 及以上
请求URL
http://127.0.0.1:54321/api/v1/setProxyAvailableUse
请求方式
GET
请求参数
参数名
必选
类型
说明
switch
是
int
1=启用,0=关闭
请求示例
· http://127.0.0.1:54321/api/v1/setProxyAvailableUse?switch=1
http://127.0.0.1:54321/api/v1/setProxyAvailableUse?switch=0
返回示例
{
//0=设置成功,大于0表示设置失败,返回的相关错误代码
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"message": "",
"data": ""
}
返回参数说明
参数名
类型
说明
备注
更多返回错误代码请看首页的错误代码描述
16、设置开启(关闭)开机自启
简要描述
设置开启(关闭)开机自启
适配版本
8.0.0.220507 及以上
请求URL
http://127.0.0.1:54321/api/v1/setAutoStart
请求方式
GET
请求参数
参数名
必选
类型
说明
switch
是
int
开关,1=启用开机自启,0=关闭开机自启
delay
是
int
开机自启启动延时(秒),0表示不延时,直接启动,设置关闭时此参数不会覆盖原来的参数
请求示例
· http://127.0.0.1:54321/api/v1/setAutoStart?switch=1&delay=15
http://127.0.0.1:54321/api/v1/setAutoStart?switch=0&delay=0
返回示例
{
//0=设置成功,大于0表示设置失败,返回的相关错误代码
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"message": "",
"data": ""
}
返回参数说明
参数名
类型
说明
备注
更多返回错误代码请看首页的错误代码描述
17、设置开启(关闭)登录成功后自动最小化
简要描述
设置开启(关闭)登录成功后自动最小化
如本机无可用节点(到期或未分配),则不会执行自动最小化
适配版本
8.0.0.220507 及以上
请求URL
http://127.0.0.1:54321/api/v1/setAutoMinimize
请求方式
GET
请求参数
参数名
必选
类型
说明
switch
是
int
开关,1=开启,0=关闭
请求示例
· http://127.0.0.1:54321/api/v1/setAutoMinimize?switch=1
http://127.0.0.1:54321/api/v1/setAutoMinimize?switch=0
返回示例
{
//0=设置成功,大于0表示设置失败,返回的相关错误代码
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"message": "",
"data": ""
}
返回参数说明
参数名
类型
说明
备注
更多返回错误代码请看首页的错误代码描述
18、设置开启(关闭)随机进程名
简要描述
设置开启(关闭)随机进程名
无忧IP客户端主进程(wuyouip.exe)每次启动时,都会随机生成一个新的进程名称启动(如:CBF1C96E6894B779.exe),来防止第三方工具检测
开启或关闭功能后,重启无忧IP客户端后生效
适配版本
8.0.0.220507 及以上
请求URL
http://127.0.0.1:54321/api/v1/setRandomProgramName
请求方式
GET
请求参数
参数名
必选
类型
说明
switch
是
int
开关,1=开启,0=关闭
请求示例
· http://127.0.0.1:54321/api/v1/setRandomProgramName?switch=1
http://127.0.0.1:54321/api/v1/setRandomProgramName?switch=0
返回示例
{
//0=设置成功,大于0表示设置失败,返回的相关错误代码
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"message": "",
"data": ""
}
返回参数说明
参数名
类型
说明
备注
更多返回错误代码请看首页的错误代码描述
19、设置开启(关闭)性能优化
简要描述
设置开启(关闭)性能优化
定期执行内存、CPU资源回收和释放操作,优化加速计算机运行速度
适配版本
8.0.0.220507 及以上
请求URL
http://127.0.0.1:54321/api/v1/setPerformanceOptimization
请求方式
GET
请求参数
参数名
必选
类型
说明
switch
是
int
开关,1=开启,0=关闭
请求示例
· http://127.0.0.1:54321/api/v1/setPerformanceOptimization?switch=1
http://127.0.0.1:54321/api/v1/setPerformanceOptimization?switch=0
返回示例
{
//0=设置成功,大于0表示设置失败,返回的相关错误代码
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"message": "",
"data": ""
}
返回参数说明
参数名
类型
说明
备注
更多返回错误代码请看首页的错误代码描述
20、设置开启(关闭)节点切换保护
简要描述
设置开启(关闭)节点切换保护
当节点连续 N 次切换失败后,将自动停止代理,防止重复使用相同节点IP(仅针对动态和全国动态类型节点)
适配版本
8.0.0.220507 及以上
请求URL
http://127.0.0.1:54321/api/v1/setNodeSwitchProtect
请求方式
GET
请求参数
参数名
必选
类型
说明
switch
是
int
开关,1=启用,0=关闭
number
是
int
允许的连续切换失败次数(不能小于1次),关闭操作时,此参数无效
请求示例
· http://127.0.0.1:54321/api/v1/setNodeSwitchProtect?switch=1&number=1
http://127.0.0.1:54321/api/v1/setNodeSwitchProtect?switch=0&number=0
返回示例
{
//0=设置成功,大于0表示设置失败,返回的相关错误代码
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"message": "",
"data": ""
}
返回参数说明
参数名
类型
说明
备注
更多返回错误代码请看首页的错误代码描述
21、设置开启(关闭)禁用本地
简要描述
设置开启(关闭)禁用本地
适配版本
8.0.0.220507 及以上
请求URL
http://127.0.0.1:54321/api/v1/setDisableLocal
请求方式
GET
请求参数
参数名
必选
类型
说明
switch
是
int
开关,1=开启,0=关闭
请求示例
· http://127.0.0.1:54321/api/v1/setDisableLocal?switch=1
http://127.0.0.1:54321/api/v1/setDisableLocal?switch=0
返回示例
{
//0=设置成功,大于0表示设置失败,返回的相关错误代码
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"message": "",
"data": ""
}
返回参数说明
参数名
类型
说明
备注
更多返回错误代码请看首页的错误代码描述
22、结束所有已代理的进程
简要描述
结束所有已代理的进程
适配版本
8.0.0.220517 及以上
8.0.0.220624 及以上,支持使用命令行参数调用(wuyouip.exe -exitAllProxyProcesses)
请求URL
http://127.0.0.1:54321/api/v1/exitAllProxyProcesses
请求方式
GET
请求示例
http://127.0.0.1:54321/api/v1/exitAllProxyProcesses
返回示例
{
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"message": "",
"data": ""
}
返回参数说明
参数名
类型
说明
备注
更多返回错误代码请看首页的错误代码描述
23、设置开启(关闭)节点无网自动切换
简要描述
设置开启(关闭)节点无网自动切换
定时自动检测节点网络状态,当检测到节点网络异常时,自动执行节点切换(驱动V5模式支持热切换,其它模式仅在未上号的情况下自动切换)
适配版本
8.0.0.220517 及以上
请求URL
http://127.0.0.1:54321/api/v1/setNodeNoNetworkSwitching
请求方式
GET
请求参数
参数名
必选
类型
说明
switch
是
int
开关,1=启用,0=关闭
请求示例
· http://127.0.0.1:54321/api/v1/setNodeNoNetworkSwitching?switch=1
http://127.0.0.1:54321/api/v1/setNodeNoNetworkSwitching?switch=0
返回示例
{
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"message": "",
"data": ""
}
返回参数说明
参数名
类型
说明
备注
更多返回错误代码请看首页的错误代码描述
24、设置开启(关闭)节点到期提醒
简要描述
设置开启(关闭)节点到期提醒
适配版本
8.0.0.220530 及以上
请求URL
http://127.0.0.1:54321/api/v1/setNodeExpireRemind
请求方式
GET
请求参数
参数名
必选
类型
说明
switch
是
int
开关,1=开启,0=关闭
请求示例
· http://127.0.0.1:54321/api/v1/setNodeExpireRemind?switch=1
http://127.0.0.1:54321/api/v1/setNodeExpireRemind?switch=0
返回示例
{
//0=设置成功,大于0表示设置失败,返回的相关错误代码
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"message": "",
"data": ""
}
返回参数说明
参数名
类型
说明
备注
更多返回错误代码请看首页的错误代码描述
25、设置开启(关闭)节点Ping功能
简要描述
设置开启(关闭)节点Ping功能
适配版本
8.0.0.220530 及以上
请求URL
http://127.0.0.1:54321/api/v1/setNodePing
请求方式
GET
请求参数
参数名
必选
类型
说明
switch
是
int
开关,1=开启,0=关闭
请求示例
· http://127.0.0.1:54321/api/v1/setNodePing?switch=1
http://127.0.0.1:54321/api/v1/setNodePing?switch=0
返回示例
{
//0=设置成功,大于0表示设置失败,返回的相关错误代码
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"message": "",
"data": ""
}
返回参数说明
参数名
类型
说明
备注
更多返回错误代码请看首页的错误代码描述
26、结束指定节点已代理的所有进程
简要描述
结束指定节点已代理的所有进程
适配版本
8.0.0.220530 及以上
请求URL
http://127.0.0.1:54321/api/v1/exitNodeProxyProcesses
请求方式
GET
请求参数
参数名
必选
类型
说明
nodeOrder
是
string
节点序号,多条节点使用英文半角(,)逗号分隔
请求示例
· http://127.0.0.1:54321/api/v1/exitNodeProxyProcesses?nodeOrder=1
http://127.0.0.1:54321/api/v1/exitNodeProxyProcesses?nodeOrder=1,2,3
返回示例
{
//0=设置成功,大于0表示设置失败,返回的相关错误代码
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"message": "",
"data": ""
}
返回参数说明
参数名
类型
说明
备注
更多返回错误代码请看首页的错误代码描述
27、请求切换所有节点
简要描述
请求切换所有节点
适配版本
8.0.0.220616 及以上
每次调用至少需要间隔15秒
驱动V5内核,支持热切换,即项目窗口不结束的情况下进行切换
非驱动V5内核,如果检测到有节点窗口数在线,则会执行跳过,仅执行没有代理窗口数的节点
8.0.0.220624 及以上,支持使用命令行参数调用(wuyouip.exe -nodeRequestSwitchAll)
请求URL
http://127.0.0.1:54321/api/v1/nodeRequestSwitchAll
请求方式
GET
请求示例
http://127.0.0.1:54321/api/v1/nodeRequestSwitchAll
返回示例
{
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"message": ""
}
返回参数说明
参数名
类型
说明
备注
更多返回错误代码请看首页的错误代码描述
更新日志
28、退出无忧IP客户端
简要描述
退出无忧IP客户端
支持使用命令行参数调用(wuyouip.exe -exitProgram)
适配版本
8.0.0.220624 及以上
请求URL
http://127.0.0.1:54321/api/v1/exitProgram
请求方式
GET
请求示例
http://127.0.0.1:54321/api/v1/exitProgram
返回示例
{
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"message": ""
}
返回参数说明
参数名
类型
说明
备注
更多返回错误代码请看首页的错误代码描述
更新日志
29、设置指定节点代理进程
简要描述
设置指定节点代理进程
如果指定代理的节点可用窗口数被使用完毕,将会自动拦截进程
适配版本
8.0.0.221215 及以上
请求URL
http://127.0.0.1:54321/api/v1/setAppointNodeProxy
请求方式
GET
请求参数
参数名
必选
类型
说明
switch
是
int
开关,1=启用,0=关闭
order
否
int
指定的节点序号(可通过拉取节点列表获得对应的节点序号),如果是设置关闭功能,可忽略此参数
请求示例
· http://127.0.0.1:54321/api/v1/setAppointNodeProxy?switch=1&order=1
http://127.0.0.1:54321/api/v1/setAppointNodeProxy?switch=0
返回示例
{
//0=设置成功,大于0表示设置失败,返回的相关错误代码
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"message": "",
"data": ""
}
返回参数说明
参数名
类型
说明
备注
更多返回错误代码请看首页的错误代码描述
30、设置节点绑定开关
简要描述
设置节点绑定开关
适配版本
8.0.0.230425 及以上
请求URL
http://127.0.0.1:54321/api/v1/setNodeBindSwitch
请求方式
GET
请求参数
参数名
必选
类型
说明
switch
是
int
开关,1=启用,0=关闭
请求示例
http://127.0.0.1:54321/api/v1/setNodeBindSwitch?switch=1
返回示例
{
//0=设置成功,大于0表示设置失败,返回的相关错误代码
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"message": "",
"data": ""
}
返回参数说明
参数名
类型
说明
备注
更多返回错误代码请看首页的错误代码描述
31、设置节点禁止重复绑定开关
简要描述
设置节点禁止重复绑定开关
适配版本
8.0.0.230425 及以上
请求URL
http://127.0.0.1:54321/api/v1/setNodeRepeatBindSwitch
请求方式
GET
请求参数
参数名
必选
类型
说明
switch
是
int
开关,1=启用,0=关闭
请求示例
http://127.0.0.1:54321/api/v1/setNodeRepeatBindSwitch?switch=1
返回示例
{
//0=设置成功,大于0表示设置失败,返回的相关错误代码
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"message": "",
"data": ""
}
返回参数说明
参数名
类型
说明
备注
更多返回错误代码请看首页的错误代码描述
32、设置节点区分模拟器绑定开关
简要描述
设置节点区分模拟器绑定开关
适配版本
8.0.0.230425 及以上
请求URL
http://127.0.0.1:54321/api/v1/setNodeDiffSimulatorBindSwitch
请求方式
GET
请求参数
参数名
必选
类型
说明
switch
是
int
开关,1=启用,0=关闭
请求示例
http://127.0.0.1:54321/api/v1/setNodeDiffSimulatorBindSwitch?switch=1
返回示例
{
//0=设置成功,大于0表示设置失败,返回的相关错误代码
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"message": "",
"data": ""
}
返回参数说明
参数名
类型
说明
备注
更多返回错误代码请看首页的错误代码描述
33、读取绑定数据列表
简要描述
获取当前设备节点已绑定数据列表
适配版本
8.0.0.230425 及以上
请求URL
http://127.0.0.1:54321/api/v1/getNodeBindDataList
请求方式
GET
请求示例
http://127.0.0.1:54321/api/v1/getNodeBindDataList
返回示例
{
"result": 0,
"timestamp": "2022-03-21 14:35:27",
"data": [
{
//节点序号
"nodeOrder": 1,
//已绑定数量
"count": 1,
//在线窗口数
"online": 0,
//已绑定模拟器序号
"simulatorOrders": ["1","2"],
//已绑定模拟器序号和模拟器名称
"simulatorNames": [{"1":"雷电模拟器"},{"2":"雷电模拟器"}],
//已绑定的进程列表
"processList": ["c:\games\a.exe","c:\games\b.exe"]
}
]
}
备注
更多返回错误代码请看错误代码描述