獲取海外動(dòng)態(tài)代理使用流量

1. 接口描述

https://fps.kdlapi.com/api/getfpsflow 英文代號(hào)：get fps flow

獲取海外動(dòng)態(tài)代理訂單對(duì)應(yīng)的總流量、當(dāng)前使用流量與當(dāng)前剩余流量，使用流量支持指定日期范圍查詢(xún)，以json格式返回。
包月付費(fèi)訂單不返回總流量和剩余流量。

必須使用訂單API密鑰調(diào)用本接口
接口最快調(diào)用頻率: 1秒1次

2. 參數(shù)說(shuō)明

參數(shù)	是否必填	參數(shù)說(shuō)明	取值說(shuō)明
secret_id	是	訂單SecretId	查看訂單API密鑰信息
sign_type	否	簽名驗(yàn)證方式。目前支持token和hmacsha1。	默認(rèn)值：token
signature	是	請(qǐng)求簽名，用來(lái)驗(yàn)證此次請(qǐng)求的合法性。此接口默認(rèn)需要驗(yàn)證簽名	支持2種簽名驗(yàn)證方式，簽名計(jì)算方法參見(jiàn)API 授權(quán)與驗(yàn)證
timestamp	否	當(dāng)前 UNIX 時(shí)間戳（秒級(jí)），可記錄發(fā)起 API 請(qǐng)求的時(shí)間。 sign_type=hmacsha1時(shí)此參數(shù)有效且為必填項(xiàng)。	例如1557546010，如果與當(dāng)前時(shí)間相差過(guò)大，會(huì)引起簽名過(guò)期錯(cuò)誤。
nonce	否	隨機(jī)正整數(shù)，與 timestamp 聯(lián)合起來(lái)，用于防止重放攻擊。建議攜帶此參數(shù)進(jìn)一步提升API安全性。 sign_type=hmacsha1時(shí)此參數(shù)有效。	客戶自行生成隨機(jī)正整數(shù)，如random.randint(1, 100000000)
start_time	否	起始日期，僅對(duì)使用流量生效	例如：2023-01-01
end_time	否	結(jié)束日期，僅對(duì)使用流量生效	例如：2023-01-02

3. 調(diào)用示例

在會(huì)員中心API密鑰管理頁(yè)得到訂單的SecretId和SecretKey：

SecretId：o1fjh1re9o28876h7c08
SecretKey：jd1gzm6ant2u7pojhbtl0bam0xpzsm1c

以密鑰令牌驗(yàn)證為例，調(diào)用獲取密鑰令牌接口得到密鑰令牌：

SecretToken：oxf0n0g59h7wcdyvz2uo68ph2s

調(diào)用示例

GET https://dev.kdlapi.com/api/getfpsflow?secret_id=o1fjh1re9o28876h7c08&signature=oxf0n0g59h7wcdyvz2uo68ph2s

使用說(shuō)明

點(diǎn)擊查看關(guān)于API授權(quán)與驗(yàn)證的介紹

4. 返回結(jié)果

接口返回json格式，字段說(shuō)明如下：

參數(shù)	說(shuō)明
code	返回碼。取值：0代表成功非0代表失敗
msg	錯(cuò)誤信息
data	包含接口返回的數(shù)據(jù)
data.flow_total	返回訂單總流量 (MB)
data.flow_use	返回當(dāng)前使用流量 (MB)
data.flow_left	返回當(dāng)前剩余流量 (MB)
data.flow_daily_usage	指定日期時(shí)，返回每個(gè)日期對(duì)應(yīng)消耗的流量

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": "參數(shù)錯(cuò)誤", "data": ""}

5. 錯(cuò)誤碼一覽

錯(cuò)誤碼	說(shuō)明
-1	參數(shù)錯(cuò)誤
-3	訂單類(lèi)型錯(cuò)誤