查询动态流量余额

查询当前调用身份的动态流量累计购买、使用和可用余额。

接口信息

项目	内容
Method	GET
Path	/open-api/v1/dynamic/traffic/balance
认证	X-API-Key
处理方式	同步

请求参数

无 Query 和请求体。

请求示例

curl --request GET \
  --url 'https://api-test.puraroute.com/gin/open-api/v1/dynamic/traffic/balance' \
  --header 'Accept: application/json' \
  --header 'X-API-Key: <YOUR_API_KEY>'

响应参数

字段	类型	可为空	说明
purchased_traffic_gb	string	否	累计购买流量
consumed_traffic_gb	string	否	累计使用流量
expired_traffic_gb	string	否	累计过期流量
adjusted_traffic_gb	string	否	累计调整流量，可为负数
available_traffic_gb	string	否	当前可用流量
balance_state	string	否	POSITIVE 表示可用余额大于 0；NON_POSITIVE 表示可用余额小于等于 0
last_calc_time	string	是	最近计算时间，GMT+8 ISO-8601
update_time	string	是	最近更新时间，GMT+8 ISO-8601

成功响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "purchased_traffic_gb": "100.000000",
    "consumed_traffic_gb": "12.500000",
    "expired_traffic_gb": "5.000000",
    "adjusted_traffic_gb": "0.000000",
    "available_traffic_gb": "82.500000",
    "balance_state": "POSITIVE",
    "last_calc_time": "2026-08-24T15:30:00.000+08:00",
    "update_time": "2026-08-24T15:30:00.000+08:00"
  },
  "next": null
}

balance_state 用于快速判断余额是否为正；需要展示具体余额时读取 available_traffic_gb。

可能的错误码

code	说明
400001	认证失败
400009	请求包含不支持的参数
500000	系统处理失败，请求未完成