查詢隧道代理當(dāng)前IP
1. 接口描述
https://tps.kdlapi.com/api/tpscurrentip 英文代號:tps current ip
實(shí)時查詢隧道代理當(dāng)前IP。
隧道代理會根據(jù)您購買時選擇的周期自動切換IP,使用途中您可以隨時調(diào)用此接口查詢隧道的當(dāng)前IP。(包含多通道的隧道會返回所有通道的當(dāng)前IP)
- 必須使用訂單API密鑰調(diào)用本接口
- 支持換IP周期>=30秒的隧道代理訂單
- 接口最快調(diào)用頻率: 1秒1次
溫馨提示:此接口不是提取代理IP的接口
隧道代理的特點(diǎn)是設(shè)置一次代理,之后會定期在云端自動切換IP,因此主流的使用方式您無需通過API提取IP,也無需處理換IP的邏輯。
此接口是用于實(shí)時查詢隧道代理的當(dāng)前IP。
如果您的使用場景需要先提取代理IP,請使用獲取隧道代理IP接口
2. 參數(shù)說明
| 參數(shù) | 是否必填 | 參數(shù)說明 | 取值說明 |
|---|---|---|---|
| secret_id | 是 | 訂單SecretId | 查看訂單API密鑰信息 |
| sign_type | 否 | 簽名驗(yàn)證方式。目前支持token和hmacsha1。 | 默認(rèn)值:token |
| signature | 是 | 請求簽名,用來驗(yàn)證此次請求的合法性。 | 支持2種簽名驗(yàn)證方式,簽名計算方法參見API 授權(quán)與驗(yàn)證 |
| timestamp | 否 | 當(dāng)前 UNIX 時間戳(秒級),可記錄發(fā)起 API 請求的時間。 sign_type=hmacsha1時此參數(shù)有效且為必填項(xiàng)。 |
例如1557546010,如果與當(dāng)前時間相差過大,會引起簽名過期錯誤。 |
| nonce | 否 | 隨機(jī)正整數(shù),與 timestamp 聯(lián)合起來,用于防止重放攻擊。建議攜帶此參數(shù)進(jìn)一步提升API安全性。 sign_type=hmacsha1時此參數(shù)有效。 |
客戶自行生成隨機(jī)正整數(shù),如random.randint(1, 100000000) |
| sid | 否 | Pro專屬參數(shù),不傳時返回當(dāng)前訂單下所有鎖定的ip。傳入則返回此sid對應(yīng)的ip。 | 長度不超過6的任意字符 |
3. 調(diào)用示例
在會員中心API密鑰管理頁得到訂單的SecretId和SecretKey:
- SecretId:
o1fjh1re9o28876h7c08 - SecretKey:
jd1gzm6ant2u7pojhbtl0bam0xpzsm1c
以密鑰令牌驗(yàn)證為例,調(diào)用獲取密鑰令牌接口得到密鑰令牌:
- SecretToken:
oxf0n0g59h7wcdyvz2uo68ph2s
調(diào)用示例
GET https://tps.kdlapi.com/api/tpscurrentip?secret_id=o1fjh1re9o28876h7c08
&signature=oxf0n0g59h7wcdyvz2uo68ph2s
使用說明
點(diǎn)擊查看關(guān)于API授權(quán)與驗(yàn)證的介紹
4. 返回結(jié)果
普通版訂單返回格式:
{
"msg": "",
"code": 0,
"data": {
"current_ip": "123.35.67.46",
"current_ip_list": ["123.35.67.46", "113.25.100.86"]
}
}
Pro訂單返回格式:
{
"msg": "",
"code": 0,
"data": {
"sid1": "123.35.67.46",
"sid2": "113.25.100.86"
}
}
字段說明如下:
| 參數(shù) | 說明 |
|---|---|
| code | 返回碼。取值:0代表成功 非0代表失敗 |
| msg | 錯誤信息 |
| data.current_ip | 隧道當(dāng)前IP。可能為空串,參見如下說明。 對多通道隧道此字段為第一個通道對應(yīng)的當(dāng)前IP。 |
| data.current_ip_list | 每個通道對應(yīng)的當(dāng)前IP。 對多通道隧道此字段包含每個通道對應(yīng)的當(dāng)前IP。 |
data.current_ip為空串的情況
data.current_ip可能為空串,有如下兩種情況:
- 隧道當(dāng)前并未被使用,所以沒有分配IP(隧道只有在使用時才會實(shí)時分配IP);
- 分配的IP已過期。
比如您購買的1分鐘換IP的隧道,但請求隧道的頻率卻是每2分鐘請求一次,調(diào)用tpscurrentip接口時距離前一次請求隧道已過去1分半鐘,前一次請求分配的IP已失效,因后一次請求尚未到來,隧道并沒有分配IP,所以返回了空串。
5. 錯誤碼一覽
| 錯誤碼 | 說明 |
|---|---|
| -3 | 訂單類型錯誤,只支持隧道代理訂單 |
| -4 | 隧道訂單不支持此接口(換IP周期>=30秒的隧道才支持) |
6. SDK
快代理提供了配套的開發(fā)工具集(SDK),支持多種編程語言,能更方便的調(diào)用 API。