设置IP白名单

1. 接口描述

https://dev.kdlapi.com/api/setipwhitelist

设置订单的IP白名单。

  1. HTTP POST接口
  2. 参数和返回内容均采用utf-8编码
  3. 接口最快调用频率: 1秒1次
  4. 此接口|错误码 | 说明 |只支持私密代理和独享代理订单

2. 参数说明

参数 是否必填 参数说明 取值说明
orderid 订单号 有效的订单号。查看我的订单
iplist IP列表 待设置的IP列表,多个IP用英文逗号分隔。例如:183.57.42.79,183.57.42.79
sign_type 签名验证方式。目前支持simple和hmacsha1。 默认值:simple
signature 请求签名,用来验证此次请求的合法性。 支持2种签名验证方式,签名计算方法参见API 授权与验证
timestamp 当前 UNIX 时间戳(秒级),可记录发起 API 请求的时间。
sign_type=hmacsha1时此参数为必填项。
例如1557546010,如果与当前时间相差过大,会引起签名过期错误。

3. 返回结果

接口返回json格式,样例:{"code": 0, "msg": "ip whitelist updated", "data": ""}

字段说明如下:

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

4. 错误码一览

错误码 说明
-1 缺少参数
-3 订单类型错误,只支持私密代理和独享代理订单
-4 iplist参数中的IP格式错误
-5 待设置的ip数量超出了上限
-6 iplist包含内网IP,只允许设置外网IP

5. 示例

订单号:965102959536478
使用简单签名验证
在会员中心订单API接口页面查看到订单的API Key为jd1gzm6ant2u7pojhbtl0bam0xpzsm1c

调用示例

requests

requests (python2/3)
# !/usr/bin/env python
# -- coding: utf-8 --
"""使用requests调用API接口
"""
import requests
# api链接
api_url = "https://dev.kdlapi.com/api/setipwhitelist"
data = {
'orderid': '965102959536478',
'iplist': '220.155.1.196,220.155.1.197', # 需要设置的白名单
'signature': 'n5g9xdqu2mokkkku0wan6gq8xcnzlhos',
}
r = requests.post(url=api_url, data=data)
print(r.status_code)  # 获取Reponse的返回码
print(r.content.decode('utf-8'))  # 获取页面内容

使用提示

  • 此样例支持 Python 2.6—2.7以及3.3—3.7
  • requests不是python原生库,需要安装才能使用: pip install requests

返回示例

{"msg": "", "code": 0, "data": {"count": 1, "ipwhitelist": ["220.155.1.196"],["220.155.1.197"] "limit": 2}}

6. SDK

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

SDK下载