OpenAPI 接口文档
OpenAPI 接口文档
查询动态子账号列表
分页查询当前账号的动态子账号。响应包含每个账号的连接密码。
接口信息
| 项目 | 内容 |
|---|---|
| Method | GET |
| Path | /open-api/v1/dynamic/accounts |
| 认证 | X-API-Key |
| 处理方式 | 同步 |
Query 参数
| 参数 | 类型 | 必填 | 说明 |
|---|---|---|---|
resource_status |
string | 否 | ACTIVE 或 REMOVED |
user_enabled |
boolean | 否 | 按调用方期望启用状态筛选 |
flow_blocked |
boolean | 否 | 按是否因流量余额条件暂停筛选 |
available |
boolean | 否 | 按当前是否满足使用条件筛选 |
sub_account_keyword |
string | 否 | 子账号名称关键字;去除首尾空白后长度 1~255;区分大小写的包含匹配;%、_、\ 按字面字符匹配 |
page_no |
integer | 否 | 默认 1,大于等于 1 |
page_size |
integer | 否 | 默认 20,范围 1~100 |
布尔 Query 值只接受小写 true 或 false。
请求示例
curl --request GET \
--url 'https://api-test.puraroute.com/gin/open-api/v1/dynamic/accounts?resource_status=ACTIVE&available=true&page_no=1&page_size=20' \
--header 'Accept: application/json' \
--header 'X-API-Key: <YOUR_API_KEY>'
响应参数
data 使用分页结构,list 元素字段与创建动态子账号相同。
limit_traffic_gb 始终返回非空的 6 位小数字符串;0.000000 表示不限额。
成功响应示例
{
"code": 0,
"msg": "success",
"data": {
"list": [
{
"id": "1912345678901234567",
"sub_account": "team_a_01",
"password": "example-secret",
"limit_traffic_gb": "10.000000",
"lifetime_used_gb": "1.250000",
"resource_status": "ACTIVE",
"user_enabled": true,
"flow_blocked": false,
"available": true,
"control_pending": false,
"last_usage_sync_time": "2026-08-24T15:20:00.000+08:00",
"create_time": "2026-08-20T10:00:00.000+08:00",
"update_time": "2026-08-24T15:30:00.000+08:00"
}
],
"total": 1,
"page_no": 1,
"page_size": 20
},
"next": null
}
可能的错误码
code |
说明 |
|---|---|
400001 |
认证失败 |
400009 |
筛选、分页或其他参数不符合要求 |
500000 |
系统处理失败,请求未完成 |
响应包含密码,不应缓存或写入普通日志。