OpenAPI 接口文档
OpenAPI 接口文档
查询动态流量订单
分页查询当前调用身份的动态流量购买订单。
接口信息
| 项目 | 内容 |
|---|---|
| Method | GET |
| Path | /open-api/v1/dynamic/traffic/orders |
| 认证 | X-API-Key |
| 处理方式 | 同步 |
Query 参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
order_no |
string | 否 | 订单号精确匹配 |
status |
string | 否 | PROCESSING、COMPLETED 或 FAILED |
create_time_start |
string | 否 | 创建时间下限,包含该时刻,带 Z 或显式偏移 |
create_time_end |
string | 否 | 创建时间上限,包含该时刻,带 Z 或显式偏移 |
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/orders?status=COMPLETED&create_time_start=2026-08-01T00%3A00%3A00%2B08%3A00&page_no=1&page_size=20' \
--header 'Accept: application/json' \
--header 'X-API-Key: <YOUR_API_KEY>'
响应参数
data 使用分页结构,list 元素如下:
| 字段 | 类型 | 可为空 | 说明 |
|---|---|---|---|
order_no |
string | 否 | 订单号 |
status |
string | 否 | PROCESSING、COMPLETED 或 FAILED |
product_code |
string | 否 | 产品编码 |
traffic_gb |
string | 否 | 购买流量,GB |
order_amount |
string | 否 | 订单金额,USD |
currency |
string | 否 | 结算币种 |
traffic_lot_id |
string | 是 | 完成后生成的流量批次 ID |
finish_time |
string | 是 | 完成时间,GMT+8 ISO-8601 |
create_time |
string | 否 | 创建时间,GMT+8 ISO-8601 |
成功响应示例
{
"code": 0,
"msg": "success",
"data": {
"list": [
{
"order_no": "PO1912345678901234567",
"status": "COMPLETED",
"product_code": "DYNAMIC_1GB",
"traffic_gb": "1.000000",
"order_amount": "0.8500",
"currency": "USD",
"traffic_lot_id": "1912345678901234568",
"finish_time": "2026-08-24T15:30:01.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 |
系统处理失败,请求未完成 |