OpenAPI 接口文档
OpenAPI 接口文档
查询有效流量批次
分页查询已经生效且尚未过期的动态流量批次。
接口信息
| 项目 | 内容 |
|---|---|
| Method | GET |
| Path | /open-api/v1/dynamic/traffic/lots |
| 认证 | X-API-Key |
| 处理方式 | 同步 |
Query 参数
| 参数 | 类型 | 必填 | 默认值 | 约束 |
|---|---|---|---|---|
page_no |
integer | 否 | 1 |
大于等于 1 |
page_size |
integer | 否 | 20 |
1~100 |
本接口不支持状态、生效时间或到期时间筛选。
请求示例
curl --request GET \
--url 'https://api-test.puraroute.com/gin/open-api/v1/dynamic/traffic/lots?page_no=1&page_size=20' \
--header 'Accept: application/json' \
--header 'X-API-Key: <YOUR_API_KEY>'
响应参数
data 使用分页结构,list 元素如下:
| 字段 | 类型 | 可为空 | 说明 |
|---|---|---|---|
id |
string | 否 | 流量批次 ID |
purchased_traffic_gb |
string | 否 | 本批次购买流量 |
consumed_traffic_gb |
string | 否 | 本批次已使用流量 |
expired_traffic_gb |
string | 否 | 本批次已过期流量 |
remaining_traffic_gb |
string | 否 | 本批次剩余流量 |
status |
string | 否 | 当前固定为 ACTIVE |
effective_time |
string | 否 | 生效时间,GMT+8 ISO-8601 |
expire_time |
string | 是 | 到期时间;空表示没有到期时间 |
create_time |
string | 否 | 创建时间,GMT+8 ISO-8601 |
成功响应示例
{
"code": 0,
"msg": "success",
"data": {
"list": [
{
"id": "1912345678901234567",
"purchased_traffic_gb": "10.000000",
"consumed_traffic_gb": "1.250000",
"expired_traffic_gb": "0.000000",
"remaining_traffic_gb": "8.750000",
"status": "ACTIVE",
"effective_time": "2026-08-24T15:30:00.000+08:00",
"expire_time": "2026-09-23T15:30:00.000+08:00",
"create_time": "2026-08-24T15:30:00.000+08:00"
}
],
"total": 1,
"page_no": 1,
"page_size": 20
},
"next": null
}
可能的错误码
code |
说明 |
|---|---|
400001 |
认证失败 |
400009 |
分页或未知参数不符合要求 |
500000 |
系统处理失败,请求未完成 |