查询隧道代理当前IP

1. 接口描述

https://tps.kdlapi.com/api/tpscurrentip 英文代号:tps current ip

实时查询隧道代理当前IP。
隧道代理会根据您购买时选择的周期自动切换IP,使用途中您可以随时调用此接口查询隧道的当前IP。

  1. HTTP GET接口
  2. 参数和返回内容均采用utf-8编码
  3. 接口最快调用频率: 1秒1次
  4. 支持换IP周期>=1分钟的隧道代理订单

温馨提示:此接口不是提取代理IP的接口

隧道代理的特点是设置一次代理,之后会定期在云端自动切换IP,因此您无需通过API提取IP,也无需处理换IP的逻辑。
此接口是用于实时查询隧道代理的当前IP。

2. 参数说明

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

3. 返回结果

接口返回json格式,样例:{"msg": "", "code": 0, "data": {"current_ip": "123.35.67.46"}}

字段说明如下:

参数 说明
code 返回码。取值:0代表成功 非0代表失败
msg 错误信息
data.current_ip 隧道当前IP。可能为空串,参见如下说明。

data.current_ip为空串的情况

data.current_ip可能为空串,有如下两种情况:

  1. 隧道当前并未被使用,所以没有分配IP(隧道只有在使用时才会实时分配IP);
  2. 分配的IP已过期。
    比如您购买的1分钟换IP的隧道,但请求隧道的频率却是每2分钟请求一次,调用tpscurrentip接口时距离前一次请求隧道已过去1分半钟,前一次请求分配的IP已失效,因后一次请求尚未到来,隧道并没有分配IP,所以返回了空串。

4. 错误码一览

错误码 说明
-3 订单类型错误,只支持隧道代理订单
-4 隧道订单不支持此接口(换IP周期>=1分钟的隧道才支持)

5. 示例

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

调用示例

orderid=965102959536478signature=jd1gzm6ant2u7pojhbtl0bam0xpzsm1c&拼接起来作为参数即可生成API链接:

https://tps.kdlapi.com/api/gettpsip?orderid=965102959536478&signature=jd1gzm6ant2u7pojhbtl0bam0xpzsm1c

返回示例

{"msg": "", "code": 0, "data": {"current_ip": "220.155.1.196"}}

6. SDK

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

SDK下载