更換隧道代理IP
1. 接口描述
https://tps.kdlapi.com/api/changetpsip 英文代號:change tps ip
更換隧道代理IP。
隧道代理會根據您購買時選擇的周期自動切換IP,但使用途中如果您發現該IP不可用,可以調用此接口讓隧道立即更換一個新IP。
多通道隧道可通過此接口更換部分或全部通道的IP。
- 必須使用訂單API密鑰調用本接口
- 支持換IP周期>=1分鐘的隧道代理訂單
- 接口最快調用頻率: 1秒1次
此接口的頻率限制
在隧道的1個換IP周期內,調用此接口更換IP的次數不能超過2次。
舉例說明:您購買的是5分鐘換IP的隧道,那么5分鐘內您最多可以調用此接口2次。
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) |
| changeip | 否 | 需要更換的IP。(多個IP用英文逗號分隔) 此參數只對多通道隧道生效。 |
此參數包含的通道IP均會通過本次調用更換。 不帶此參數或參數值為空串代表更換所有通道IP。 |
3. 調用示例
在會員中心API密鑰管理頁得到訂單的SecretId和SecretKey:
- SecretId:
o1fjh1re9o28876h7c08 - SecretKey:
jd1gzm6ant2u7pojhbtl0bam0xpzsm1c
以密鑰令牌驗證為例,調用獲取密鑰令牌接口得到密鑰令牌:
- SecretToken:
oxf0n0g59h7wcdyvz2uo68ph2s
調用示例
GET https://tps.kdlapi.com/api/changetpsip?secret_id=o1fjh1re9o28876h7c08
&signature=oxf0n0g59h7wcdyvz2uo68ph2s
使用說明
點擊查看關于API授權與驗證的介紹
4. 返回結果
接口返回json格式,樣例:
{
"msg": "",
"code": 0,
"data": {
"new_ip": "123.35.67.46",
"new_ip_list": ["123.35.67.46", "125.100.86.128"]
}
}
字段說明如下:
| 參數 | 說明 |
|---|---|
| code | 返回碼。取值:0代表成功 非0代表失敗 |
| msg | 錯誤信息 |
| data.new_ip | 新更換的IP。 對多通道隧道此字段為第一個通道更換后的新IP。 |
| data.new_ip_list | 新更換的IP列表。 對多通道隧道此字段包含每個通道更換后的新IP。 |
5. 錯誤碼一覽
| 錯誤碼 | 說明 |
|---|---|
| -3 | 訂單類型錯誤,只支持隧道代理訂單 |
| -4 | 隧道訂單不支持此接口(換IP周期>=1分鐘的隧道才支持) |
| -5 | 換IP次數超限 |
6. SDK
快代理提供了配套的開發工具集(SDK),支持多種編程語言,能更方便的調用 API。