OpenAPI 接口文档
OpenAPI 接口文档
查询静态代理续费订单
分页查询当前调用身份的静态代理续费订单。
接口信息
| 项目 | 内容 |
|---|---|
| Method | GET |
| Path | /open-api/v1/static/renewal-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/static/renewal-orders?status=PROCESSING&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 |
duration_days |
integer | 否 | 统一续费时长 |
total_quantity |
integer | 否 | 去重后的资源数量 |
order_amount |
string | 否 | 订单金额,USD |
currency |
string | 否 | 结算币种 |
create_time |
string | 否 | 创建时间,GMT+8 ISO-8601 |
finish_time |
string | 是 | COMPLETED 时为全部资源完成时间;FAILED 时为首次出现失败结果的时间,不表示全部资源均已处理结束;PROCESSING 时为空 |
成功响应示例
{
"code": 0,
"msg": "success",
"data": {
"list": [
{
"order_no": "PO1912345678901234567",
"status": "PROCESSING",
"duration_days": 30,
"total_quantity": 2,
"order_amount": "16.0000",
"currency": "USD",
"create_time": "2026-08-24T15:30:00.000+08:00",
"finish_time": null
}
],
"total": 1,
"page_no": 1,
"page_size": 20
},
"next": null
}
一个续费订单中的多个资源可能部分成功。订单为 COMPLETED 时可以停止轮询;订单为 FAILED 时,仅凭列表结果不能判断所有资源是否都已处理结束,必须继续查询订单详情,直到 resources 中所有 status 都不再是 PROCESSING。已经续费成功的资源仍保留新的到期时间;不会自动退款,请联系客户支持人工处理。人工处理后,应重新查询详情获取最新结果。
可能的错误码
code |
说明 |
|---|---|
400001 |
认证失败 |
400009 |
状态、时间、分页或其他参数不符合要求 |
500000 |
系统处理失败,请求未完成 |