OpenAPI 接口文档
OpenAPI 接口文档

创建动态子账号

创建一个动态子账号,并返回账号状态和连接密码。创建前,当前动态流量可用余额必须大于 0。

接口信息

项目 内容
Method POST
Path /open-api/v1/dynamic/accounts
认证 X-API-Key
Content-Type application/json
处理方式 同步
请求号 必填,保护期 24 小时

请求体

字段 类型 必填 说明 约束
request_no string 仅用于防止重复受理的调用方请求号 1~64 位,仅字母、数字、_-
sub_account string 调用方可识别的子账号名称 去除首尾空白后 3~32 位;以字母或数字开头和结尾,中间可使用字母、数字、_-
limit_traffic_gb string 生命周期累计流量限额,GB 非负普通十进制字符串,最多 6 位小数;省略时默认为 0.0000000 表示不限额

sub_account 创建后不可修改,并在当前账号下永久占用;即使账号后来被移除,也不能再次使用相同名称。名称区分大小写。

请求示例

curl --request POST \
  --url 'https://api-test.puraroute.com/gin/open-api/v1/dynamic/accounts' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <YOUR_API_KEY>' \
  --data '{
    "request_no": "account-20260824-001",
    "sub_account": "team_a_01",
    "limit_traffic_gb": "10.000000"
  }'

响应参数

字段 类型 可为空 说明
id string 动态子账号 ID
sub_account string 子账号名称
password string 代理连接密码,敏感信息
limit_traffic_gb string 生命周期累计流量限额;固定 6 位小数,0.000000 表示不限额
lifetime_used_gb string 生命周期累计已使用流量
resource_status string ACTIVEREMOVED
user_enabled boolean 调用方期望的启用状态
flow_blocked boolean 是否因流量余额条件而暂停使用
available boolean 当前是否满足使用条件
control_pending boolean 状态变更是否仍在生效过程中
last_usage_sync_time string 最近一次用量更新时间
create_time string 创建时间,GMT+8 ISO-8601
update_time string 更新时间,GMT+8 ISO-8601

成功响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "id": "1912345678901234567",
    "sub_account": "team_a_01",
    "password": "example-secret",
    "limit_traffic_gb": "10.000000",
    "lifetime_used_gb": "0.000000",
    "resource_status": "ACTIVE",
    "user_enabled": true,
    "flow_blocked": false,
    "available": true,
    "control_pending": false,
    "last_usage_sync_time": null,
    "create_time": "2026-08-24T15:30:00.000+08:00",
    "update_time": "2026-08-24T15:30:00.000+08:00"
  },
  "next": null
}

可能的错误码

code 说明 建议处理
300006 请求号重复 查询账号列表,不要重放
300340 动态流量余额非正 先购买动态流量
300341 动态子账号达到上限 复用现有账号或联系支持人员
300358 子账号名称已存在 更换名称和请求号
400001 认证失败 检查 API Key
400009 请求参数不符合要求 修正请求
500000 系统处理失败,创建结果可能无法确认 先查询账号列表,不要立即使用新请求号再创建

响应包含密码,请按敏感信息处理。

request_no 仅用于防止重复受理,不是结果查询键,也不会重放第一次结果。详见请求号与重复提交

On this page