代理管理

Updated by MoreLogin

3.1 添加代理

基本信息

POST  /proxy/add

接口描述：添加自有代理。仅支持系统版本为 1.9.7.18 - 1.9.20.18 之间版本（目前仅支持 Windows 计算机）。

请求参数

Header parameters

参数名称

类型

必传

默认值

样例

描述

x-api-key

string

是

-

-

每个MoreLogin用户都有自己特殊的API-key，您可以在系统api页面中查看

主体参数，可选参数可以省略。参数格式为JSON。

参数名称

类型

必传

默认值

样例

描述

addr

string

否

-

-

代理地址是必需的，除非provider是 11、12、13，在这种情况下代理地址无效。

is_detect_proxy

number

否

-

-

不提供或将该值设置为 0 表示无需检查代理的可用性。将该值设置为 1 或任何其他值表示需要检查代理的可用性。

port

integer

否

-

-

端口（仅支持1到65535之间的数字）

除非provider值为 11、12 或 13，否则端口号是必需的。在这些情况下，端口号不适用。

proxy_type

integer

否

-

1

代理类型:

  • 1: HTTP
  • 2: HTTPS
  • 3: SOCKS5
  • 4: SSH

请注意，proxy_type 和provider 不能同时为空。

provider

integer

否

-

-

代理提供商：

  • 1: Oxylabs
  • 2: Proxys.io
  • 3: Luminati
  • 4: Lumauto
  • 5: Oxylabsauto
  • 6: Trojan
  • 7: Shadowsocks
  • 8: ABCPROXY
  • 9: LunaProxy
  • 10: IPHTML
  • 11: PiaProxy
  • 12: 922S5
  • 13: 360Proxy

如果provider设置为3（Luminati）或4（Lumauto），则必须指定代理类型（proxy_type），并且只能为1（HTTP）或2（HTTPS）。在其他情况下，如果提供者有值，则代理类型不适用。

encryption_type

integer

否

-

-

加密方式：

  • 1: aes-128-gcm
  • 2: aes-192-gcm
  • 3: aes-256-gcm
  • 4: aes-128-cfb
  • 5: aes-192-cfb
  • 6: aes-256-cfb
  • 7: aes-128-ctr
  • 8: aes-192-ctr
  • 9: aes-256-ctr
  • 10: rc4-md5
  • 11: chacha20-ietf
  • 12: xchacha20
  • 13: chacha20-ietf-poly1305
  • 14: xchacha20-ietf-poly1305

如果provider设置为 7 (Shadowsocks)，则必须指定加密类型 (encryption_type)。在其他情况下，加密类型不适用。

username

string 

否

-

-

用户名（最多100个字符）

passwd

string

否

-

-

密码(最多100个字符)

refresh_url

string 

否

刷新网址（限制为600个字符，仅支持URL格式: “https://\* http://\*”）

country

string

否

-

-

国家（具体国家代码参见附录），当provider为11、12、13时，必填，否则为选填。

state

string

否

-

-

州；省

city

string

否

-

-

城市

返回数据

{
    "ret": 0,             //Result: 0 - Success, 500 - Server error
    "data": {
        "id": 0           //proxy id
    },
    "error": {
        "code": "string", //error code
        "msg": "string"   //error reason
    }
}

错误码

biz_code exception

描述

1003

代理检测失败

-1

代理程序启动失败

3.2 编辑代理

基本信息

POST  /proxy/edit

接口描述：如需修改代理相关信息，仅支持系统版本为 1.9.7.18 - 1.9.20.18 之间版本（目前仅支持 Windows 计算机）。

请求参数

Header parameters

参数名称

类型

必传

默认值

样例

描述

x-api-key

string

是

-

-

每个MoreLogin用户都有自己特殊的API-key，您可以在系统api页面中查看

主体参数，可选参数可以省略。参数格式为JSON。

参数名称

类型

必传

默认值

样例

描述

id

integer

是

-

-

代理 id

name

string

否

-

proxy1

代理名称

addr

string

否

-

-

当provider设置为 11、12 或 13 时，代理地址不适用。

is_detect_proxy

number

否

-

-

不指定或传递 0 意味着不需要检查代理可用性。指定 1 或任何其他值表示需要检查代理可用性。

port

integer

否

-

-

端口（仅支持1到65535之间的数字）

当provider 设置为 11, 12或 13的时候，端口无需填写

proxy_type

integer

否

-

1

代理类型:

  • 1: HTTP
  • 2: HTTPS
  • 3: SOCKS5
  • 4: SSH

请注意，proxy_type 和provider 不能同时为空。

provider

integer

否

-

-

代理提供商:

  • 1: Oxylabs
  • 2: Proxys.io
  • 3: Luminati
  • 4: Lumauto
  • 5: Oxylabsauto
  • 6: Trojan
  • 7: Shadowsocks
  • 8: ABCPROXY
  • 9: LunaProxy
  • 10: IPHTML
  • 11: PiaProxy
  • 12: 922S5
  • 13: 360Proxy

当provider设置为3或4时，proxy_type字段为必填项，且只能设置为1或2。其他情况下，当provider有值时，proxy_type字段不适用。

encryption_type

integer

否

-

-

加密方式:

  • 1: aes-128-gcm
  • 2: aes-192-gcm
  • 3: aes-256-gcm
  • 4: aes-128-cfb
  • 5: aes-192-cfb
  • 6: aes-256-cfb
  • 7: aes-128-ctr
  • 8: aes-192-ctr
  • 9: aes-256-ctr
  • 10: rc4-md5
  • 11: chacha20-ietf
  • 12: xchacha20
  • 13: chacha20-ietf-poly1305
  • 14: xchacha20-ietf-poly1305

当provider设置为 7 时，加密类型字段是必需的。在其他情况下，encryption_type 字段不适用

username

string 

否

-

-

用户名（最多100个字符）

passwd

string

否

-

-

密码(最多100个字符)

refresh_url

string 

否

刷新网址（限制为600个字符，仅支持URL格式：“ https://\* http://\*”）

country

string

否

-

-

国家（具体国家代码见附录）

state

string

否

-

-

州、省

city

string

否

-

-

城市

返回数据

{
    "ret": 0,
    "msg": "string"
}

错误码

biz_code exception

描述

1003

代理检测失败

-1

代理程序启动失败

3.3 删除代理

基本信息

POST  /proxy/delete

接口描述：删除不需要的代理支持一次仅删除一个代理。仅支持系统版本为 1.9.7.18 - 1.9.20.18 之间版本（目前仅支持 Windows 计算机）。

请求参数

Header parameters

参数名称

类型

必传

默认值

样例

描述

x-api-key

string

是

-

-

每个MoreLogin用户都有自己特殊的API-key，您可以在系统api页面中查看

主体参数，可选参数可以省略。参数格式为JSON。

参数名称

类型

必传

默认值

样例

描述

id

integer

是

-

-

代理ID

返回参数

{
    "ret": 0,          //error code
    "msg": "string"    //error information
}

3.4 获取代理列表

基本信息

GET  /proxy/list

接口描述：查询已添加代理信息的API，允许用户检索自己有权限访问的代理信息。仅支持系统版本为 1.9.7.18 - 1.9.20.18 之间版本（目前仅支持 Windows 计算机）。

请求参数

Header parameters

参数名称

类型

必传

默认值

样例

描述

x-api-key

string

是

-

-

每个MoreLogin用户都有自己特殊的API-key，您可以在系统api页面中查看

查询参数，可选参数可以省略。

参数名称

类型

必传

默认值

样例

描述

id

integer

否

-

-

代理 id

name

string

否

-

proxy1

代理名称

addr

string

否

-

-

代理地址

platform_type

integer

否

-

1

代理类型

0: 平台 IP 1: 自有 IP

proxy_type

integer

否

-

1

代理类型:

  • 1: HTTP
  • 2: HTTPS
  • 3: SOCKS5
  • 4: SSH

provider

integer

否

-

1

代理供应商:

  • 1: Oxylabs
  • 2: Proxys.io
  • 3: Luminati
  • 4: Lumauto
  • 5: Oxylabsauto
  • 6: Trojan
  • 7: Shadowsocks
  • 8: ABCPROXY
  • 9: LunaProxy
  • 10: IPHTML
  • 11: PiaProxy
  • 12: 922S5
  • 13: 360Proxy

status

integer

否

-

0

代理状态

0: 正常

1: 已过期

2: 待分配

3: 即将过期

4: 未知

5: 检测失败

page

integer

否

1

1

页数：默认1，当页数较多需要翻页时使用

page_size

integer

否

10

20

页面大小：默认每页10个，最大100个

返回数据

{
    "ret": 0,                      //错误码
    "msg": "string",
    "count": 0,                    //总计数
    "data": [                      //代理列表
        {
            "id": 0,               //代理 id
            "name": "string",      //代理名称
            "addr": "string",      //代理地址
            "platform_type": 0,    //代理平台类型 0:平台IP 1:自有IP
            "proxy_type": 0,       //代理类型 1:http 2:https 3:socks5 4:ssh 
            "provider": 0,         //代理供应商
            "status": 0,           //代理状态
            "expiry": 0            //过期时间
        }
    ]
}

How did we do?