OpenAPI 接口文档
OpenAPI 接口文档
查询静态代理资源
分页查询当前账号全部符合筛选条件的静态代理资源,不按资源创建入口过滤。响应包含连接账号和密码。
接口信息
| 项目 | 内容 |
|---|---|
| Method | GET |
| Path | /open-api/v1/static/resources |
| 认证 | X-API-Key |
| 处理方式 | 同步 |
Query 参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
static_type |
string | 否 | ISP 或 ISP_NATIVE |
region_code |
string | 否 | 地区编码精确匹配;不能是空串 |
resource_status |
string | 否 | ACTIVE 或 EXPIRED |
expire_time_start |
string | 否 | 到期时间下限,包含该时刻,带 Z 或显式偏移 |
expire_time_end |
string | 否 | 到期时间上限,包含该时刻,带 Z 或显式偏移 |
ip_keyword |
string | 否 | IP 地址前缀;去除首尾空白后 1~64 位,仅允许 0-9、A-F、a-f、.、: |
page_no |
integer | 否 | 默认 1,大于等于 1 |
page_size |
integer | 否 | 默认 20,范围 1~100 |
开始时间不能晚于结束时间。ip_keyword 为前缀匹配,不是任意位置包含匹配。
请求示例
curl --request GET \
--url 'https://api-test.puraroute.com/gin/open-api/v1/static/resources?static_type=ISP&resource_status=ACTIVE&page_no=1&page_size=20' \
--header 'Accept: application/json' \
--header 'X-API-Key: <YOUR_API_KEY>' \
--header 'X-LANG: zh_CN'
响应参数
data 使用分页结构,list 元素如下:
查询结果可能包含 HTTP 或 SOCKS5 资源;通过本 Open API 创建的购买订单资源固定为 HTTP。
| 字段 | 类型 | 可为空 | 说明 |
|---|---|---|---|
id |
string | 否 | 静态代理资源 ID |
static_type |
string | 否 | ISP 或 ISP_NATIVE |
region_code |
string | 否 | 地区编码 |
region_name |
string | 否 | 与 X-LANG 对应的地区名称 |
host |
string | 是 | 代理连接主机 |
ip |
string | 否 | 静态代理 IP |
port |
integer | 否 | 代理连接端口 |
account |
string | 是 | 代理连接账号,敏感信息 |
password |
string | 是 | 代理连接密码,敏感信息 |
protocol |
string | 否 | HTTP 或 SOCKS5 |
resource_status |
string | 否 | ACTIVE 或 EXPIRED |
buy_time |
string | 否 | 购买时间,GMT+8 ISO-8601 |
expire_time |
string | 否 | 当前到期时间,GMT+8 ISO-8601 |
create_time |
string | 否 | 资源创建时间,GMT+8 ISO-8601 |
update_time |
string | 否 | 资源更新时间,GMT+8 ISO-8601 |
成功响应示例
{
"code": 0,
"msg": "success",
"data": {
"list": [
{
"id": "1912345678901234568",
"static_type": "ISP",
"region_code": "107",
"region_name": "United States",
"host": "203.0.113.10",
"ip": "203.0.113.10",
"port": 8000,
"account": "proxy_user",
"password": "example-secret",
"protocol": "HTTP",
"resource_status": "ACTIVE",
"buy_time": "2026-08-24T15:30:00.000+08:00",
"expire_time": "2026-09-23T15:30:00.000+08:00",
"create_time": "2026-08-24T15:35:00.000+08:00",
"update_time": "2026-08-24T15:35:00.000+08:00"
}
],
"total": 1,
"page_no": 1,
"page_size": 20
},
"next": null
}
资源一旦已经生成并满足查询条件,就可能出现在本列表中;这与购买订单必须完整完成后才在详情中返回全部资源的规则不同。
可能的错误码
code |
说明 |
|---|---|
400001 |
认证失败 |
400009 |
筛选、时间、IP 前缀、分页或其他参数不符合要求 |
500000 |
系统处理失败,请求未完成 |
响应包含连接账号和密码,不应缓存或写入普通日志。