OpenAPI 接口文档
OpenAPI 接口文档
查询静态代理续费订单详情
按订单号查询静态代理续费订单及每个资源的最新续费结果。
接口信息
| 项目 | 内容 |
|---|---|
| Method | GET |
| Path | /open-api/v1/static/renewal-orders/{order_no} |
| 认证 | X-API-Key |
| 处理方式 | 同步 |
路径参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
order_no |
string | 是 | 静态代理续费订单号,不能是空串 |
不接受 Query 参数。
请求示例
curl --request GET \
--url 'https://api-test.puraroute.com/gin/open-api/v1/static/renewal-orders/PO1912345678901234567' \
--header 'Accept: application/json' \
--header 'X-API-Key: <YOUR_API_KEY>'
响应参数
响应包含续费订单列表项的全部字段,并增加 resources:
| 字段 | 类型 | 说明 |
|---|---|---|
resources |
array | 本次续费的资源级结果 |
resources 元素:
| 字段 | 类型 | 可为空 | 说明 |
|---|---|---|---|
resource_id |
string | 否 | 静态代理资源 ID |
status |
string | 否 | PROCESSING、COMPLETED 或 FAILED |
expire_time |
string | 否 | 该资源当前到期时间,GMT+8 ISO-8601 |
duration_days |
integer | 否 | 本次续费时长 |
finish_time |
string | 是 | 该资源完成或失败时间;处理中为空 |
订单级 finish_time 在 COMPLETED 时表示全部资源完成的时间;在 FAILED 时表示首次出现失败结果的时间,不表示全部资源均已处理结束;订单为 PROCESSING 时为空。
成功响应示例
{
"code": 0,
"msg": "success",
"data": {
"order_no": "PO1912345678901234567",
"status": "COMPLETED",
"duration_days": 30,
"total_quantity": 2,
"order_amount": "16.0000",
"currency": "USD",
"create_time": "2026-08-24T15:30:00.000+08:00",
"finish_time": "2026-08-24T15:35:00.000+08:00",
"resources": [
{
"resource_id": "1912345678901234568",
"status": "COMPLETED",
"expire_time": "2026-10-23T15:30:00.000+08:00",
"duration_days": 30,
"finish_time": "2026-08-24T15:34:30.000+08:00"
},
{
"resource_id": "1912345678901234569",
"status": "COMPLETED",
"expire_time": "2026-10-23T15:30:00.000+08:00",
"duration_days": 30,
"finish_time": "2026-08-24T15:35:00.000+08:00"
}
]
},
"next": null
}
轮询停止条件
- 订单为
PROCESSING时,继续查询。 - 订单为
COMPLETED时,全部资源均已完成,可以停止自动轮询。 - 订单为
FAILED时,不代表所有资源都已处理结束。只要resources中仍有PROCESSING,就继续查询;所有资源都不再是PROCESSING后,再停止自动轮询并联系客户支持。
同一订单中的多个资源可能部分成功。即使订单为 FAILED,COMPLETED 资源的新 expire_time 仍然保留。FAILED 不会自动退款。人工处理后,应重新调用本接口获取最新结果。
回调只会在订单第一次进入 COMPLETED 或 FAILED 时发送一次,失败不重试,也不会在剩余资源处理结束后再次发送。无论是否收到回调,都应以本接口的最新响应为准。
可能的错误码
code |
说明 |
|---|---|
300001 |
订单不存在或不可访问 |
400001 |
认证失败 |
400009 |
路径或请求参数不符合要求 |
500000 |
系统处理失败,请求未完成 |