更换隧道代理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。