Local API V2 – 代理接口

查询代理列表

接口地址

GET /openapi/v2/proxies

用于查询代理列表。

查询参数

名称	类型	必填	说明
page	integer	否	页码分页页码，从 1 开始。
page_size	integer	否	页码分页每页数量。
cursor	string	否	游标分页标记。
limit	integer	否	游标分页每页数量。
serial_no	integer	否	代理序号。
id	string	否	代理 ID。
type	string	否	代理类型。
host	string	否	代理主机。
remark	string	否	备注。
proxy_group_id	string	否	代理分组 ID。

响应中的 data.list 为代理列表项，字段见 代理响应字段。

创建代理

接口地址

POST /openapi/v2/proxies

用于创建代理。

请求参数

请求体使用代理新增或修改参数，见 代理参数。

请求示例

 {
    "type": "http",
    "host": "127.0.0.1",
    "port": 8080,
    "user": "",
    "password": "",
    "ipchecker": "ipapi",
    "ip_version": "ipv4",
    "remark": "proxy created by Local API V2"
  }

获取代理详情

接口地址

GET /openapi/v2/proxies/{proxyId}

路径参数

名称	类型	必填	说明
proxyId	string	是	代理 ID。

修改代理

接口地址

PATCH /openapi/v2/proxies/{proxyId}

路径参数

名称	类型	必填	说明
proxyId	string	是	代理 ID。

请求参数

请求体使用代理新增或修改参数，见 代理参数。

删除代理

接口地址

DELETE /openapi/v2/proxies/{proxyId}

路径参数

名称	类型	必填	说明
proxyId	string	是	代理 ID。

检测已保存代理

接口地址

POST /openapi/v2/proxies/{proxyId}/check

用于检测已保存代理。

路径参数

名称	类型	必填	说明
proxyId	string	是	代理 ID。

检测临时代理

接口地址

POST /openapi/v2/proxies/check

用于检测未保存的临时代理。

请求参数

请求体使用代理检测参数，见 代理检测参数。

响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "ok": true,
    "out_ip": "1.2.3.4",
    "country": "United States",
    "country_code": "US",
    "region": "California",
    "city": "Los Angeles",
    "timezone": "America/Los_Angeles",
    "status": "success",
    "error_message": ""
  },
  "next": null
}

data.status 可选值为 wait、success、fail。

参数说明

代理参数

ProxyUpsertRequest 用于创建和修改代理。

名称	类型	必填	说明
type	string	否	代理类型。可选值：none、http、https、ssh、socks5。
host	string	否	代理主机。
port	integer	否	代理端口。
user	string	否	代理账号。
password	string	否	代理密码。
ipchecker	string	否	IP 检测渠道。可选值：ip2location、ipapi。
ip_version	string	否	IP 地址类型。可选值：ipv4、ipv6。
remark	string	否	备注。
proxy_group_id	string	否	代理分组 ID。

代理检测参数

ProxyCheckRequest 用于检测临时代理。

名称	类型	必填	说明
type	string	否	代理类型。可选值：none、http、https、ssh、socks5。
host	string	否	代理主机。
port	integer	否	代理端口。
user	string	否	代理账号。
password	string	否	代理密码。
ipchecker	string	否	IP 检测渠道。可选值：ip2location、ipapi。
ip_version	string	否	IP 地址类型。可选值：ipv4、ipv6。
timeout_ms	integer	否	超时时间，单位毫秒。

代理响应字段

名称	类型	说明
proxy_id	string	代理 ID。
serial_no	integer	代理序号。
type	string	代理类型。可选值：none、http、https、ssh、socks5。
host	string	代理主机。
port	integer	代理端口。
user	string	代理账号。
password	string	代理密码。
ipchecker	string	IP 检测渠道。可选值：ip2location、ipapi。
ip_version	string	IP 地址类型。可选值：ipv4、ipv6。
proxy_group_id	string	代理分组 ID。
remark	string	备注。