获取海外动态代理使用流量
1. 接口描述
https://fps.kdlapi.com/api/getfpsflow 英文代号:get fps flow
获取海外动态代理订单对应的总流量、当前使用流量与当前剩余流量,使用流量支持指定日期范围查询,以json格式返回。
包月付费订单不返回总流量和剩余流量。
- 必须使用订单API密钥调用本接口
- 接口最快调用频率: 1秒1次
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) |
start_time | 否 | 起始日期,仅对使用流量生效 | 例如:2023-01-01 |
end_time | 否 | 结束日期,仅对使用流量生效 | 例如:2023-01-02 |
3. 调用示例
在会员中心API密钥管理页得到订单的SecretId和SecretKey:
- SecretId:
o1fjh1re9o28876h7c08
- SecretKey:
jd1gzm6ant2u7pojhbtl0bam0xpzsm1c
以密钥令牌验证为例,调用获取密钥令牌接口得到密钥令牌:
- SecretToken:
oxf0n0g59h7wcdyvz2uo68ph2s
调用示例
GET https://dev.kdlapi.com/api/getfpsflow?secret_id=o1fjh1re9o28876h7c08&signature=oxf0n0g59h7wcdyvz2uo68ph2s
使用说明
点击查看关于API授权与验证的介绍
4. 返回结果
接口返回json格式,字段说明如下:
参数 | 说明 |
---|---|
code | 返回码。取值:0代表成功 非0代表失败 |
msg | 错误信息 |
data | 包含接口返回的数据 |
data.flow_total | 返回订单总流量 (MB) |
data.flow_use | 返回当前使用流量 (MB) |
data.flow_left | 返回当前剩余流量 (MB) |
data.flow_daily_usage | 指定日期时,返回每个日期对应消耗的流量 |
json格式
正常返回格式样例:
{
"msg": "",
"code": 0,
"data": {
"flow_total": 1024.0,
"flow_use": 512.0,
"flow_left": 512.0,
"flow_daily_usage": {
"2023-01-01": 100.0,
"2023-01-02": 100.0
}
}
}
异常返回格式样例:
{"code": -1, "msg": "参数错误", "data": ""}
5. 错误码一览
错误码 | 说明 |
---|---|
-1 | 参数错误 |
-3 | 订单类型错误 |