设置代理IP白名单
最新更新时间:2021.09.15¶
本接口主要用于设置代理的IP白名单授权。 如果您需要使用IP白名单来使用代理,则可以使用本接口快速设置。
1. 接口说明¶
- 适用对象:所有付费用户
- 请求URL:http://v2.api.juliangip.com/postpay/setwhiteip
- 请求方式:POST/GET
- 请求频率:1次/秒
2. 参数说明¶
参数名 | 变量 | 变量类型 | 是否必填 | 参数说明 |
---|---|---|---|---|
业务编号 | trade_no | string | 是 | 由巨量系统生成的业务编号,全局唯一。 示例值:1765244755300652 查看我的订单 |
IP列表 | ips | string | 是 | 待设置的IP列表,多个IP用英文逗号分隔。 例如: 8.8.8.8,9.9.9.9 |
加密签名 | sign | string | 是 | 根据规则加密后的sign字符串 示例值: 3a6e9419fc9de3425e87b7e63bc6d444 |
3. 调用示例¶
在产品管理生成提取链接得到业务编号和API Key。
- 业务编号:
1765244755300652
- IP列表:
8.8.8.8,9.9.9.9
- key:
3a6e9419fc9de3425e87b7e63bc6d444
调用示例
为订单设置如下两个IP为白名单:8.8.8.8
, 9.9.9.9
GET http://v2.api.juliangip.com/postpay/setwhiteip?
trade_no=1765244755300652
&ips=8.8.8.8,9.9.9.9
&sign=d293ef57d4e5d3f8ce8ab221116598b3
Api加密规则详解
sign的计算方式请点击查看Api加密规则详解
4. 返回结果¶
请求成功返回示例¶
{
"code": 200,
"msg": "成功",
"data": {
"white_ip_count": 5,
"surplus_white_ip_quantity": 2,
"current_white_ip": [
"7.7.7.7",
"8.8.8.8",
"9.9.9.9",
]
}
}
请求失败返回示例¶
{
"code": 401,
"msg": "签名验证失败,请检查签名参数和方法是否都符合签名算法要求",
"data": []
}
错误提示
大部分错误都可以在【公共错误及解决方案】找到解决办法,具体错误原因请参照msg字段中的错误原因释义,我们尽可能为您提供详细的错误原因提示。
5、返回参数释义¶
参数名 | 变量 | 变量类型 | 是否必返 | 参数说明 |
---|---|---|---|---|
返回码 | code | int | 是 | 返回结果状态码 示例值:200 |
结果描述 | msg | string | 是 | 针对于状态码的详细描述。 示例值:请求成功 |
数据内容 | data | object | 是 | 包含接口返回的数据 |
可使用白名单总数 | data.white_ip_count | int | 否 | 此业务可设置的白名单总数 |
当前白名单 | data.current_white_ip | string | 否 | 此业务当前已设置的白名单IP列表 |
剩余可使用白名单数量 | data.surplus_white_ip_quantity | int | 否 | 业务当前剩余可设置的白名单数量 |