設置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. 錯誤碼一覽
| 錯誤碼 | 說明 |
|---|---|
| -3 | 訂單類型錯誤，只支持私密代理、隧道代理、獨享代理、海外代理動態住宅、海外代理靜態住宅 |
| -4 | iplist參數中的IP格式錯誤 |
| -5 | 待設置的ip數量超出了上限 |
| -6 | iplist包含內網IP，只允許設置外網IP |
| -7 | 該IP已被其他訂單（可能是其他用戶的訂單）設置為白名單 |
6. SDK
快代理提供了配套的開發工具集（SDK），支持多種編程語言，能更方便的調用 API。