獲取海外動態代理使用流量
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 | 訂單類型錯誤 |