取消
最近搜索
清空历史

设置IP白名单

1. 接口描述

https://dev.kdlapi.com/api/setipwhitelist 英文代号:set ip whitelist

设置订单的IP白名单。
如果您是希望追加IP到现有的白名单,调用添加白名单IP接口会更简单。

  • 必须使用订单API密钥调用本接口
  • 支持私密代理 / 隧道代理 / 独享代理 /开放代理专业版订单
  • 接口最快调用频率: 1秒1次
  • 每次设置一分钟后生效

温馨提示

如需把本机IP加入白名单,可调用接口获取本机IP

2. 参数说明

参数 是否必填 参数说明 取值说明
secret_id 订单SecretId 查看订单API密钥信息
sign_type 签名验证方式。目前支持token和hmacsha1。 默认值:token
signature 请求签名,用来验证此次请求的合法性。 支持2种签名验证方式,签名计算方法参见API 授权与验证
timestamp 当前 UNIX 时间戳(秒级),可记录发起 API 请求的时间。
sign_type=hmacsha1时此参数为必填项。
例如1557546010,如果与当前时间相差过大,会引起签名过期错误。
nonce 随机正整数,与 timestamp 联合起来,用于防止重放攻击。建议携带此参数进一步提升API安全性。
sign_type=hmacsha1时此参数有效。
客户自行生成随机正整数,如random.randint(1, 100000000)
iplist IP列表 待设置的IP列表,多个IP用英文逗号分隔。例如:183.57.42.78,183.57.42.79
不带此参数代表设置您的当前IP作为白名单

3. 调用示例

在会员中心API密钥管理页得到订单的SecretId和SecretKey:

  • SecretId:o1fjh1re9o28876h7c08
  • SecretKey:jd1gzm6ant2u7pojhbtl0bam0xpzsm1c

以密钥令牌验证为例,调用获取密钥令牌接口得到密钥令牌:

  • SecretToken:oxf0n0g59h7wcdyvz2uo68ph2s

调用示例

为订单设置如下两个IP为白名单:183.57.42.78, 183.57.42.79

GET https://dev.kdlapi.com/api/setipwhitelist?secret_id=o1fjh1re9o28876h7c08
&iplist=183.57.42.78,183.57.42.79
&signature=oxf0n0g59h7wcdyvz2uo68ph2s

使用说明

点击查看关于API授权与验证的介绍

4. 返回结果

接口返回json格式,样例:

{
  "code": 0,
  "msg": "ip whitelist updated to 183.57.42.78,183.57.42.79",
  "data": ""
}

字段说明如下:

参数 说明
code 返回码。取值:0代表成功 非0代表失败
msg 错误信息
data 空串

5. 错误码一览

错误码 说明
-1 缺少参数
-3 订单类型错误,只支持私密代理、隧道代理、独享代理、开放代理专业版订单
-4 iplist参数中的IP格式错误
-5 待设置的ip数量超出了上限
-6 iplist包含内网IP,只允许设置外网IP
-7 该IP已被其他订单(可能是其他用户的订单)设置为白名单
适用于隧道代理私密代理按IP付费(专业版)

6. SDK

快代理提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

SDK下载

联系我们
  • 售前在线咨询
    咨询享免费测试,专业工程师提供技术支持
  • 客服热线
    400-058-0638  周一至周六 9:00-18:30
  • 提交工单
    您的每一次反馈我们都认真对待
  • 客服微信 & QQ
    客服微信:kuaidaili,客服QQ:800849628
  • 企业客户通道
    提交需求后专业的售前工程师为您提供服务