Print

1、概述

概述

无忧IP客户端8.0版本接口说明文档

接口地址

默认地址

文档版本
更新日志

2、标准数据返回格式

{
    //本次请求接口名称
    "action": "v1/nodeNetworkDetection",
    //返回的消息内容,只有当result不等于0的情况下才会返回,一般用于错误消息
    "message": "",
    //接口执行结果,0表示成功,非0为错误代码
    "result": 0,
    //请求时间
    "timestamp": "2022-04-01 16:50:57",
    //返回的关联数据,依据不同接口返回不同数据结果集
    "data": {
        "HttpRequestTime": 195
    }
}

3、获取用户唯一id

简要描述
适配版本
请求URL
请求方式
请求示例
返回示例
{
    "result": 0,
    "timestamp": "2022-03-21 14:35:27",
    "message": "",
    //用户唯一id
    "data": "d0970714757783e6cf17b26fb8e2298f"
}
返回参数说明
参数名 类型 说明
备注

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

简要描述
适配版本
请求URL
请求方式
请求示例
返回示例
  {
    "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、请求切换节点

简要描述
适配版本
请求URL
请求方式
请求参数
参数名 必选 类型 说明
nodeOrder int 需要请求切换的节点序号
请求示例
返回示例
{
    "result": 0,
    "timestamp": "2022-03-21 14:35:27",
    "message": ""
}
返回参数说明
参数名 类型 说明
备注
更新日志

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

6、批量请求切换节点

简要描述
适配版本
请求URL
请求方式
请求参数
参数名 必选 类型 说明
nodeOrder string 需要请求切换的节点序号,多条节点之间使用英文半角(,)逗号分隔,示例:1,2,3
请求示例
返回示例
{
    "result": 0,
    "timestamp": "2022-03-21 14:35:27",
    "message": ""
}
返回参数说明
参数名 类型 说明
备注

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

简要描述
适配版本
请求URL
请求方式
请求示例
返回示例
  {
    "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、节点网络检测

简要描述
适配版本
请求URL
请求方式
请求参数
参数名 必选 类型 说明
nodeOrder int 需要检测的节点序号
请求示例
返回示例
{
    "result": 0,
    "timestamp": "2022-03-21 14:35:27",
    "message": "",
    "data": {
        //请求成功数据响应时间ms
        "HttpRequestTime": 123
    }
}
返回参数说明
参数名 类型 说明
备注

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

简要描述
适配版本
请求URL
请求方式
请求参数
参数名 必选 类型 说明
pid int 进程id
请求示例
返回示例
{
    "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、提交节点网络检测

简要描述
适配版本
请求URL
请求方式
请求参数
参数名 必选 类型 说明
nodeOrder string 需要请求切换的节点序号,多个之间使用半角英文逗号分隔,例如:1,2,3,4
请求示例
返回示例
{
    "result": 0,
    "timestamp": "2022-03-21 14:35:27",
    "message": "",
    "data": [{
        //提交结果,success = 提交成功,waiting = 节点正在执行检测中,failed = 提交失败
        "result": "success",
        //错误消息,只有当提交结果返回失败的时候有
        "message": "",
        //节点序号
        "nodeOrder": 1,
        //请求时间戳,便于对应查询结果,如果返回执行中,则返回的时间戳是上一次提交的时间戳
        "timestamp": 1234567890123
    }]
}
返回参数说明
参数名 类型 说明
- - -
备注

11、查询节点网络检测结果

简要描述
适配版本
请求URL
请求方式
请求参数
参数名 必选 类型 说明
nodeOrder string 需要查询的节点序号,多个之间使用半角英文逗号分隔,例如:1,2,3,4
请求示例
返回示例
{
    "result": 0,
    "timestamp": "2022-03-21 14:35:27",
    "message": "",
    "data": [{
        //查询状态,success = 检测成功,waiting = 执行中,failed = 检测失败
        "result": "success",
        //节点序号
        "nodeOrder": 1,
        //请求耗时
        "duration": 11,
        //请求时间戳,对应最后一次请求的时间戳,如果返回执行中,则返回的时间戳是上一次提交的时间戳
        "timestamp": 1234567890123,
        //失败的情况下返回的错误消息内容
        "message": ""
    }]
}
返回参数说明
参数名 类型 说明
- - -
备注

12、获取客户端版本号

简要描述
适配版本
请求URL
请求方式
请求示例
返回示例
{
    "result": 0,
    "timestamp": "2022-03-21 14:35:27",
    "message": "",
    //客户端版本号,其中 220418 表示 2位年份+月份+日期,如果同一天发布了多次更新,则增加数字表示,如:8.0.0.220418.1
    "data": "8.0.0.220418"
}
返回参数说明
参数名 类型 说明
备注

13、设置DNS代理开关

简要描述
适配版本
请求URL
请求方式
请求参数
参数名 必选 类型 说明
switch int 开关,1=开,0=关
server string DNS服务地址,默认:114.114.114.114
port int DNS服务端口,默认:53
请求示例
返回示例
{
    //0=设置成功,大于0表示设置失败,返回的相关错误代码
    "result": 0,
    "timestamp": "2022-03-21 14:35:27",
    "message": "",
    "data": ""
}
返回参数说明
参数名 类型 说明
备注

14、设置上号顺序方式

简要描述
适配版本
请求URL
请求方式
请求参数
参数名 必选 类型 说明
mode string 模式,loop=循环模式 order=顺序模式
请求示例
返回示例
{
    //0=设置成功,大于0表示设置失败,返回的相关错误代码
    "result": 0,
    "timestamp": "2022-03-21 14:35:27",
    "message": "",
    "data": ""
}
返回参数说明
参数名 类型 说明
备注

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

简要描述
适配版本
请求URL
请求方式
请求参数
参数名 必选 类型 说明
switch int 1=启用,0=关闭
请求示例
返回示例
{
    //0=设置成功,大于0表示设置失败,返回的相关错误代码
    "result": 0,
    "timestamp": "2022-03-21 14:35:27",
    "message": "",
    "data": ""
}
返回参数说明
参数名 类型 说明
备注

16、设置开启(关闭)开机自启

简要描述
适配版本
请求URL
请求方式
请求参数
参数名 必选 类型 说明
switch int 开关,1=启用开机自启,0=关闭开机自启
delay int 开机自启启动延时(秒),0表示不延时,直接启动,设置关闭时此参数不会覆盖原来的参数
请求示例
返回示例
{
    //0=设置成功,大于0表示设置失败,返回的相关错误代码
    "result": 0,
    "timestamp": "2022-03-21 14:35:27",
    "message": "",
    "data": ""
}
返回参数说明
参数名 类型 说明
备注

17、设置开启(关闭)登录成功后自动最小化

简要描述
适配版本
请求URL
请求方式
请求参数
参数名 必选 类型 说明
switch int 开关,1=开启,0=关闭
请求示例
返回示例
{
    //0=设置成功,大于0表示设置失败,返回的相关错误代码
    "result": 0,
    "timestamp": "2022-03-21 14:35:27",
    "message": "",
    "data": ""
}
返回参数说明
参数名 类型 说明
备注

18、设置开启(关闭)随机进程名

简要描述
适配版本
请求URL
请求方式
请求参数
参数名 必选 类型 说明
switch int 开关,1=开启,0=关闭
请求示例
返回示例
{
    //0=设置成功,大于0表示设置失败,返回的相关错误代码
    "result": 0,
    "timestamp": "2022-03-21 14:35:27",
    "message": "",
    "data": ""
}
返回参数说明
参数名 类型 说明
备注

19、设置开启(关闭)性能优化

简要描述
适配版本
请求URL
请求方式
请求参数
参数名 必选 类型 说明
switch int 开关,1=开启,0=关闭
请求示例
返回示例
{
    //0=设置成功,大于0表示设置失败,返回的相关错误代码
    "result": 0,
    "timestamp": "2022-03-21 14:35:27",
    "message": "",
    "data": ""
}
返回参数说明
参数名 类型 说明
备注

20、设置开启(关闭)节点切换保护

简要描述
适配版本
请求URL
请求方式
请求参数
参数名 必选 类型 说明
switch int 开关,1=启用,0=关闭
number int 允许的连续切换失败次数(不能小于1次),关闭操作时,此参数无效
请求示例
返回示例
{
    //0=设置成功,大于0表示设置失败,返回的相关错误代码
    "result": 0,
    "timestamp": "2022-03-21 14:35:27",
    "message": "",
    "data": ""
}
返回参数说明
参数名 类型 说明
备注

21、设置开启(关闭)禁用本地

简要描述
适配版本
请求URL
请求方式
请求参数
参数名 必选 类型 说明
switch int 开关,1=开启,0=关闭
请求示例
返回示例
{
    //0=设置成功,大于0表示设置失败,返回的相关错误代码
    "result": 0,
    "timestamp": "2022-03-21 14:35:27",
    "message": "",
    "data": ""
}
返回参数说明
参数名 类型 说明
备注

22、结束所有已代理的进程

简要描述
适配版本
请求URL
请求方式
请求示例
返回示例
{
    "result": 0,
    "timestamp": "2022-03-21 14:35:27",
    "message": "",
    "data": ""
}
返回参数说明
参数名 类型 说明
备注

23、设置开启(关闭)节点无网自动切换

简要描述
适配版本
请求URL
请求方式
请求参数
参数名 必选 类型 说明
switch int 开关,1=启用,0=关闭
请求示例
返回示例
{
    "result": 0,
    "timestamp": "2022-03-21 14:35:27",
    "message": "",
    "data": ""
}
返回参数说明
参数名 类型 说明
备注

24、设置开启(关闭)节点到期提醒

简要描述
适配版本
请求URL
请求方式
请求参数
参数名 必选 类型 说明
switch int 开关,1=开启,0=关闭
请求示例
返回示例
{
    //0=设置成功,大于0表示设置失败,返回的相关错误代码
    "result": 0,
    "timestamp": "2022-03-21 14:35:27",
    "message": "",
    "data": ""
}
返回参数说明
参数名 类型 说明
备注

25、设置开启(关闭)节点Ping功能

简要描述
适配版本
请求URL
请求方式
请求参数
参数名 必选 类型 说明
switch int 开关,1=开启,0=关闭
请求示例
返回示例
{
    //0=设置成功,大于0表示设置失败,返回的相关错误代码
    "result": 0,
    "timestamp": "2022-03-21 14:35:27",
    "message": "",
    "data": ""
}
返回参数说明
参数名 类型 说明
备注

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

简要描述
适配版本
请求URL
请求方式
请求参数
参数名 必选 类型 说明
nodeOrder string 节点序号,多条节点使用英文半角(,)逗号分隔
请求示例
返回示例
{
    //0=设置成功,大于0表示设置失败,返回的相关错误代码
    "result": 0,
    "timestamp": "2022-03-21 14:35:27",
    "message": "",
    "data": ""
}
返回参数说明
参数名 类型 说明
备注

27、请求切换所有节点

简要描述
适配版本
请求URL
请求方式
请求示例
返回示例
{
    "result": 0,
    "timestamp": "2022-03-21 14:35:27",
    "message": ""
}
返回参数说明
参数名 类型 说明
备注
更新日志

28、退出无忧IP客户端

简要描述
适配版本
请求URL
请求方式
请求示例
返回示例
{
    "result": 0,
    "timestamp": "2022-03-21 14:35:27",
    "message": ""
}
返回参数说明
参数名 类型 说明
备注
更新日志

29、设置指定节点代理进程

简要描述
适配版本
请求URL
请求方式
请求参数
参数名 必选 类型 说明
switch int 开关,1=启用,0=关闭
order int 指定的节点序号(可通过拉取节点列表获得对应的节点序号),如果是设置关闭功能,可忽略此参数
请求示例
返回示例
{
    //0=设置成功,大于0表示设置失败,返回的相关错误代码
    "result": 0,
    "timestamp": "2022-03-21 14:35:27",
    "message": "",
    "data": ""
}
返回参数说明
参数名 类型 说明
备注

30、设置节点绑定开关

简要描述
适配版本
请求URL
请求方式
请求参数
参数名 必选 类型 说明
switch int 开关,1=启用,0=关闭
请求示例
返回示例
{
    //0=设置成功,大于0表示设置失败,返回的相关错误代码
    "result": 0,
    "timestamp": "2022-03-21 14:35:27",
    "message": "",
    "data": ""
}
返回参数说明
参数名 类型 说明
备注

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

简要描述
适配版本
请求URL
请求方式
请求参数
参数名 必选 类型 说明
switch int 开关,1=启用,0=关闭
请求示例
返回示例
{
    //0=设置成功,大于0表示设置失败,返回的相关错误代码
    "result": 0,
    "timestamp": "2022-03-21 14:35:27",
    "message": "",
    "data": ""
}
返回参数说明
参数名 类型 说明
备注

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

简要描述
适配版本
请求URL
请求方式
请求参数
参数名 必选 类型 说明
switch int 开关,1=启用,0=关闭
请求示例
返回示例
{
    //0=设置成功,大于0表示设置失败,返回的相关错误代码
    "result": 0,
    "timestamp": "2022-03-21 14:35:27",
    "message": "",
    "data": ""
}
返回参数说明
参数名 类型 说明
备注

33、读取绑定数据列表

简要描述
适配版本
请求URL
请求方式
请求示例
返回示例
  {
    "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"]
        }
    ]
  }
备注