无忧IP电脑端API接口-无忧IP电脑端API

概述

接口地址：http://127.0.0.1:54321其中端口是基于54321起始，如果端口被占用，则会基于此端口 + 1，最大到 54331

文档版本：20230425

更新日志

20230425

1、增加设置节点绑定开关
2、增加设置节点禁止重复绑定开关
3、增加设置节点区分模拟器绑定开关
4、增加读取绑定数据列表

20221215

1、增加设置指定节点代理进程功能

20220624

1、增加退出无忧IP客户端，支持命令行参数调用
2、结束所有已代理的进程，增加支持命令行参数调用
3、请求切换所有节点，增加支持命令行参数调用

20220616

1、增加请求切换所有节点

20220530

1、增加设置开启（关闭）节点到期提醒开关
2、增加设置开启（关闭）节点状态ping检测
3、增加结束指定节点已代理的所有进程

20220517

1、增加结束所有已代理的进程
2、增加设置开启（关闭）节点无网自动切换

20220507

1、增加设置开启（关闭）开机自启
2、增加设置开启（关闭）登录成功后自动最小化
3、增加设置开启（关闭）随机进程名
4、增加设置开启（关闭）性能优化
5、增加设置开启（关闭）节点切换保护
6、增加设置开启（关闭）禁用本地

20220504

1、增加设置DNS代理开关接口
2、增加设置上号顺序方式接口
3、增加设置是否启用始终从可用节点开始代理接口

20220415

1、新增接口和优化文档说明

20220418

1、新增获取用户唯一ID接口文档说明
2、新增获取客户端版本号接口
3、优化单条节点切换接口，请求限制调整为每条限制
4、优化文档结构，标记各个接口适配版本号
5、客户端 windows 7 版本，增加接口支持

标准返回格式

接口返回的数据格式遵循以下标准：

{
  "action": "string", // 动作类型
  "message": "string", // 消息描述
  "result": number, // 结果状态码
  "timestamp": number, // 时间戳
  "data": object // 数据内容
}

action: 接口动作类型
message: 操作结果描述信息
result: 操作结果状态码，0表示成功，非0表示失败
timestamp: 操作时间戳
data: 返回的具体数据内容，格式因接口而异

获取用户唯一id GET

获取用户唯一id

版本: 8.0.0.220406 及以上

URL: http://127.0.0.1:54321/api/v1/getUserIdentitySessionId

请求示例

http://127.0.0.1:54321/api/v1/getUserIdentitySessionId

返回格式

{
  "result": 0,
  "timestamp": "2022-03-21 14:35:27",
  "message": "",
  "data": "d0970714757783e6cf17b26fb8e2298f"
}

备注

更多返回错误代码请看首页的错误代码描述

获取当前本机已分配的节点列表数据 GET

获取当前本机已分配的节点列表数据

版本: 8.0.0.220406 及以上

URL: http://127.0.0.1:54321/api/v1/getAllotNodeList

请求示例

http://127.0.0.1:54321/api/v1/getAllotNodeList

返回格式

{
  "result": 0,
  "timestamp": "2022-03-21 14:35:27",
  "data": [
    {
      "type": "动态",
      "order": 1,
      "number": "jj0001",
      "regionName": "九江电信",
      "itemName": "魔兽世界全服",
      "expire": 123456,
      "allot": 2,
      "proxy": 0
    }
  ]
}

备注

更多返回错误代码请看错误代码描述

请求切换节点 GET

请求切换节点

版本: 8.0.0.220406 及以上接口请求限制规则优化适配 8.0.0.220418 及以上

URL: http://127.0.0.1:54321/api/v1/nodeRequestSwitch

参数

参数名	类型	必填	描述
nodeOrder	int	* 是	需要请求切换的节点序号

请求示例

http://127.0.0.1:54321/api/v1/nodeRequestSwitch?nodeOrder=1

返回格式

{
  "result": 0,
  "timestamp": "2022-03-21 14:35:27",
  "message": ""
}

备注

更多返回错误代码请看首页的错误代码描述

更新日志

20220418，优化节点请求时间限制，全局限制改为单条节点限制

批量请求切换节点 GET

请求切换节点

版本: 8.0.0.220406 及以上

URL: http://127.0.0.1:54321/api/v1/nodeBatchRequestSwitch

参数

参数名	类型	必填	描述
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": ""
}

备注

更多返回错误代码请看首页的错误代码描述

获取所有已经代理的进程列表 GET

获取所有已经代理的进程列表

版本: 8.0.0.220406 及以上

URL: http://127.0.0.1:54321/api/v1/getAllProxyProcessLists

请求示例

http://127.0.0.1:54321/api/v1/getAllProxyProcessLists

返回格式

{
  "result": 0,
  "timestamp": "2022-03-21 14:35:27",
  "message": "",
  "data": [
    {
      "nodeOrder": 1,
      "ppid": 111,
      "pid": 222,
      "name": "a.exe",
      "flowSend": "123k",
      "flowReceive": "123k"
    }
  ]
}

备注

更多返回错误代码请看首页的错误代码描述

节点网络检测 GET

节点网络检测（推荐使用异步接口，参考提交节点网络检测接口和查询节点网络检测接口）

版本: 8.0.0.220406 及以上

URL: http://127.0.0.1:54321/api/v1/nodeNetworkDetection

参数

参数名	类型	必填	描述
nodeOrder	int	* 是	需要检测的节点序号

请求示例

http://127.0.0.1:54321/api/v1/nodeNetworkDetection?nodeOrder=1

返回格式

{
  "result": 0,
  "timestamp": "2022-03-21 14:35:27",
  "message": "",
  "data": {
    "HttpRequestTime": 123
  }
}

备注

更多返回错误代码请看首页的错误代码描述

查询指定进程ID是否已经成功代理 GET

查询指定进程ID是否已经成功代理

版本: 8.0.0.220415 及以上

URL: http://127.0.0.1:54321/api/v1/queryProcessIsProxy

参数

参数名	类型	必填	描述
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": 1234,
    "name": "123.exe",
    "parentId": 321,
    "parentName": "abc.exe",
    "sendFlow": 1234,
    "reviceFlow": 1234
  }
}

备注

更多返回错误代码请看首页的错误代码描述

提交节点网络检测 GET

提交节点网络检测

版本: 8.0.0.220415 及以上

URL: http://127.0.0.1:54321/api/v1/submitNodeNetworkDetection

参数

参数名	类型	必填	描述
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": [
    {
      "result": "success",
      "message": "",
      "nodeOrder": 1,
      "timestamp": 1234567890123
    }
  ]
}

备注

更多返回错误代码请看首页的错误代码描述

查询节点网络检测结果 GET

提交节点网络检测

版本: 8.0.0.220415 及以上

URL: http://127.0.0.1:54321/api/v1/queryNodeNetworkDetection

参数

参数名	类型	必填	描述
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": [
    {
      "result": "success",
      "nodeOrder": 1,
      "duration": 11,
      "timestamp": 1234567890123,
      "message": ""
    }
  ]
}

备注

更多返回错误代码请看首页的错误代码描述

获取客户端版本号 GET

请求切换节点

版本: 8.0.0.220418 及以上

URL: http://127.0.0.1:54321/api/v1/getClientVersion

请求示例

http://127.0.0.1:54321/api/v1/getClientVersion

返回格式

{
  "result": 0,
  "timestamp": "2022-03-21 14:35:27",
  "message": "",
  "data": "8.0.0.220418"
}

备注

更多返回错误代码请看首页的错误代码描述

设置DNS代理开关 GET

设置DNS代理开关（开启后，将使用远程节点代理IP解析域名地址）关闭DNS代理的时候，除了switch请求参数，其它请求参数均视为无效，防止覆盖原来的参数海外节点，开启DNS代理，请设置DNS服务地址，否则将有可能导致DNS解析失败，最终导致上号失败仅驱动V5模式下支持

版本: 8.0.0.220504 及以上

URL: http://127.0.0.1:54321/api/v1/setDnsProxySwitch

参数

参数名	类型	必填	描述
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

返回格式

{
  "result": 0,
  "timestamp": "2022-03-21 14:35:27",
  "message": "",
  "data": ""
}

备注

更多返回错误代码请看首页的错误代码描述

设置上号顺序方式 GET

设置上号顺序方式每次设置后，将重置上号索引信息，及从第一条节点开始

版本: 8.0.0.220504 及以上

URL: http://127.0.0.1:54321/api/v1/setProxyOrderMode

参数

参数名	类型	必填	描述
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

返回格式

{
  "result": 0,
  "timestamp": "2022-03-21 14:35:27",
  "message": "",
  "data": ""
}

备注

更多返回错误代码请看首页的错误代码描述

设置是否启用始终从可用节点开始代理 GET

设置是否启用始终从可用节点开始代理循环代理始终从可用节点开始代理，顺序代理始终从未上满节点开始代理每次设置后，将重置上号索引信息，及从第一条节点开始

版本: 8.0.0.220504 及以上

URL: http://127.0.0.1:54321/api/v1/setProxyAvailableUse

参数

参数名	类型	必填	描述
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

返回格式

{
  "result": 0,
  "timestamp": "2022-03-21 14:35:27",
  "message": "",
  "data": ""
}

备注

更多返回错误代码请看首页的错误代码描述

设置开启（关闭）开机自启 GET

设置开启（关闭）开机自启

版本: 8.0.0.220507 及以上

URL: http://127.0.0.1:54321/api/v1/setAutoStart

参数

参数名	类型	必填	描述
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

返回格式

{
  "result": 0,
  "timestamp": "2022-03-21 14:35:27",
  "message": "",
  "data": ""
}

备注

更多返回错误代码请看首页的错误代码描述

设置开启（关闭）登录成功后自动最小化 GET

设置开启（关闭）登录成功后自动最小化如本机无可用节点（到期或未分配），则不会执行自动最小化

版本: 8.0.0.220507 及以上

URL: http://127.0.0.1:54321/api/v1/setAutoMinimize

参数

参数名	类型	必填	描述
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

返回格式

{
  "result": 0,
  "timestamp": "2022-03-21 14:35:27",
  "message": "",
  "data": ""
}

备注

更多返回错误代码请看首页的错误代码描述

设置开启（关闭）随机进程名 GET

设置开启（关闭）随机进程名无忧IP客户端主进程（wuyouip.exe）每次启动时，都会随机生成一个新的进程名称启动（如：CBF1C96E6894B779.exe），来防止第三方工具检测开启或关闭功能后，重启无忧IP客户端后生效

版本: 8.0.0.220507 及以上

URL: http://127.0.0.1:54321/api/v1/setRandomProgramName

参数

参数名	类型	必填	描述
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

返回格式

{
  "result": 0,
  "timestamp": "2022-03-21 14:35:27",
  "message": "",
  "data": ""
}

备注

更多返回错误代码请看首页的错误代码描述

设置开启（关闭）性能优化 GET

设置开启（关闭）性能优化定期执行内存、CPU资源回收和释放操作，优化加速计算机运行速度

版本: 8.0.0.220507 及以上

URL: http://127.0.0.1:54321/api/v1/setPerformanceOptimization

参数

参数名	类型	必填	描述
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

返回格式

{
  "result": 0,
  "timestamp": "2022-03-21 14:35:27",
  "message": "",
  "data": ""
}

备注

更多返回错误代码请看首页的错误代码描述

设置开启（关闭）节点切换保护 GET

设置开启（关闭）节点切换保护当节点连续 N 次切换失败后，将自动停止代理，防止重复使用相同节点IP（仅针对动态和全国动态类型节点）

版本: 8.0.0.220507 及以上

URL: http://127.0.0.1:54321/api/v1/setNodeSwitchProtect

参数

参数名	类型	必填	描述
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

返回格式

{
  "result": 0,
  "timestamp": "2022-03-21 14:35:27",
  "message": "",
  "data": ""
}

备注

更多返回错误代码请看首页的错误代码描述

设置开启（关闭）禁用本地 GET

设置开启（关闭）禁用本地

版本: 8.0.0.220507 及以上

URL: http://127.0.0.1:54321/api/v1/setDisableLocal

参数

参数名	类型	必填	描述
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

返回格式

{
  "result": 0,
  "timestamp": "2022-03-21 14:35:27",
  "message": "",
  "data": ""
}

备注

更多返回错误代码请看首页的错误代码描述

结束所有已代理的进程 GET

结束所有已代理的进程

版本: 8.0.0.220517 及以上 8.0.0.220624 及以上，支持使用命令行参数调用（wuyouip.exe -exitAllProxyProcesses）

URL: http://127.0.0.1:54321/api/v1/exitAllProxyProcesses

请求示例

http://127.0.0.1:54321/api/v1/exitAllProxyProcesses

返回格式

{
  "result": 0,
  "timestamp": "2022-03-21 14:35:27",
  "message": "",
  "data": ""
}

备注

更多返回错误代码请看首页的错误代码描述

设置开启（关闭）节点无网自动切换 GET

设置开启（关闭）节点无网自动切换定时自动检测节点网络状态，当检测到节点网络异常时，自动执行节点切换（驱动V5模式支持热切换，其它模式仅在未上号的情况下自动切换）

版本: 8.0.0.220517 及以上

URL: http://127.0.0.1:54321/api/v1/setNodeNoNetworkSwitching

参数

参数名	类型	必填	描述
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": ""
}

备注

更多返回错误代码请看首页的错误代码描述

设置开启（关闭）节点到期提醒 GET

设置开启（关闭）节点到期提醒

版本: 8.0.0.220530 及以上

URL: http://127.0.0.1:54321/api/v1/setNodeExpireRemind

参数

参数名	类型	必填	描述
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

返回格式

{
  "result": 0,
  "timestamp": "2022-03-21 14:35:27",
  "message": "",
  "data": ""
}

备注

更多返回错误代码请看首页的错误代码描述

设置开启（关闭）节点Ping功能 GET

设置开启（关闭）节点Ping功能

版本: 8.0.0.220530 及以上

URL: http://127.0.0.1:54321/api/v1/setNodePing

参数

参数名	类型	必填	描述
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

返回格式

{
  "result": 0,
  "timestamp": "2022-03-21 14:35:27",
  "message": "",
  "data": ""
}

备注

更多返回错误代码请看首页的错误代码描述

结束指定节点已代理的所有进程 GET

结束指定节点已代理的所有进程

版本: 8.0.0.220530 及以上

URL: http://127.0.0.1:54321/api/v1/exitNodeProxyProcesses

参数

参数名	类型	必填	描述
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

返回格式

{
  "result": 0,
  "timestamp": "2022-03-21 14:35:27",
  "message": "",
  "data": ""
}

备注

更多返回错误代码请看首页的错误代码描述

请求切换所有节点 GET

请求切换所有节点每次调用至少需要间隔15秒驱动V5内核，支持热切换，即项目窗口不结束的情况下进行切换非驱动V5内核，如果检测到有节点窗口数在线，则会执行跳过，仅执行没有代理窗口数的节点 8.0.0.220624 及以上，支持使用命令行参数调用（wuyouip.exe -nodeRequestSwitchAll）

版本: 8.0.0.220616 及以上

URL: http://127.0.0.1:54321/api/v1/nodeRequestSwitchAll

请求示例

http://127.0.0.1:54321/api/v1/nodeRequestSwitchAll

返回格式

{
  "result": 0,
  "timestamp": "2022-03-21 14:35:27",
  "message": ""
}

备注

更多返回错误代码请看首页的错误代码描述

退出无忧IP客户端 GET

退出无忧IP客户端支持使用命令行参数调用（wuyouip.exe -exitProgram）

版本: 8.0.0.220624 及以上

URL: http://127.0.0.1:54321/api/v1/exitProgram

请求示例

http://127.0.0.1:54321/api/v1/exitProgram

返回格式

{
  "result": 0,
  "timestamp": "2022-03-21 14:35:27",
  "message": ""
}

备注

更多返回错误代码请看首页的错误代码描述

设置指定节点代理进程 GET

设置指定节点代理进程如果指定代理的节点可用窗口数被使用完毕，将会自动拦截进程

版本: 8.0.0.221215 及以上

URL: http://127.0.0.1:54321/api/v1/setAppointNodeProxy

参数

参数名	类型	必填	描述
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

返回格式

{
  "result": 0,
  "timestamp": "2022-03-21 14:35:27",
  "message": "",
  "data": ""
}

备注

更多返回错误代码请看首页的错误代码描述

设置节点绑定开关 GET

设置节点绑定开关

版本: 8.0.0.230425 及以上

URL: http://127.0.0.1:54321/api/v1/setNodeBindSwitch

参数

参数名	类型	必填	描述
switch	int	* 是	开关，1=启用，0=关闭

请求示例

http://127.0.0.1:54321/api/v1/setNodeBindSwitch?switch=1

返回格式

{
  "result": 0,
  "timestamp": "2022-03-21 14:35:27",
  "message": "",
  "data": ""
}

备注

更多返回错误代码请看首页的错误代码描述

设置节点禁止重复绑定开关 GET

设置节点禁止重复绑定开关

版本: 8.0.0.230425 及以上

URL: http://127.0.0.1:54321/api/v1/setNodeRepeatBindSwitch

参数

参数名	类型	必填	描述
switch	int	* 是	开关，1=启用，0=关闭

请求示例

http://127.0.0.1:54321/api/v1/setNodeRepeatBindSwitch?switch=1

返回格式

{
  "result": 0,
  "timestamp": "2022-03-21 14:35:27",
  "message": "",
  "data": ""
}

备注

更多返回错误代码请看首页的错误代码描述

设置节点区分模拟器绑定开关 GET

设置节点区分模拟器绑定开关

版本: 8.0.0.230425 及以上

URL: http://127.0.0.1:54321/api/v1/setNodeDiffSimulatorBindSwitch

参数

参数名	类型	必填	描述
switch	int	* 是	开关，1=启用，0=关闭

请求示例

http://127.0.0.1:54321/api/v1/setNodeDiffSimulatorBindSwitch?switch=1

返回格式

{
  "result": 0,
  "timestamp": "2022-03-21 14:35:27",
  "message": "",
  "data": ""
}

备注

更多返回错误代码请看首页的错误代码描述

读取绑定数据列表 GET

获取当前设备节点已绑定数据列表

版本: 8.0.0.230425 及以上

URL: http://127.0.0.1:54321/api/v1/getNodeBindDataList

请求示例

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"
      ]
    }
  ]
}

备注

更多返回错误代码请看错误代码描述