蜻蜓代理白名单 API 说明文档

前言

为了方便开发者,这里提供 API,用于动态更新 IP 白名单。需要注意的是,token 目前还不能修改,注意保管好。

1. 添加 IP 白名单

URL

https://proxy.horocn.com/api/ip/whitelist

HTTP 请求方法

PUT

请求参数

参数 必选 类型 说明
token ture string API token,通过用户中心 - 用户信息页面可获取
ip true string 需要添加的 IP 白名单,例如:8.8.8.8

正确返回结果

{
    "code"0,
    "msg""ok"
}

错误返回结果

{
    "msg""白名单记录已存在",
    "code"400
}

2. 删除 IP 白名单

URL

https://proxy.horocn.com/api/ip/whitelist

HTTP 请求方法

DELETE

请求参数

参数 必选 类型 说明
token ture string API token,通过用户中心 - 用户信息页面可获取
ip true string 需要添加的 IP 白名单,例如:8.8.8.8

正确返回结果

{
    "code"0,
    "msg""ok"
}

错误返回结果

{
    "msg""删除 IP 白名单(1.1.1.1)失败,可能原因:白名单不存在或白名单已删除",
    "code"500
}

3. 查询 IP 白名单

URL

https://proxy.horocn.com/api/ip/whitelist

HTTP 请求方法

GET

请求参数

参数 必选 类型 说明
token ture string API token,通过用户中心 - 用户信息页面可获取

正确返回结果

{
    "msg""OK",
    "code"0,
    "count"2,
    "data": [
        "1.1.1.1",
        "2.2.2.3"
    ]
}

错误返回结果

{
    "msg""token(a2649301ddd26a09f6512babbe903879X)不存在",
    "code"422
}

4. 清空所有 IP 白名单

URL

https://proxy.horocn.com/api/ip/whitelist/all

HTTP 请求方法

GET

请求参数

参数 必选 类型 说明
token ture string API token,通过用户中心 - 用户信息页面可获取

正确返回结果

{
    "code"0,
    "msg""OK",
    "data": {
        "effected_count"2
    }
}

错误返回结果

{
    "msg""token(a2649301ddd26a09f6512babbe903879X)不存在",
    "code"422
}

转载请注明