OpenAPI 接口文档
OpenAPI 接口文档

修改动态子账号流量限额

修改动态子账号的生命周期累计流量限额。子账号名称不会改变,响应不返回密码。

接口信息

项目 内容
Method PATCH
Path /open-api/v1/dynamic/accounts/{id}
认证 X-API-Key
Content-Type application/json
处理方式 同步

路径参数

参数 类型 必填 说明
id string 动态子账号 ID

请求体

字段 类型 必填 说明 约束
limit_traffic_gb string 新的生命周期累计流量限额,GB 非负普通十进制字符串,最多 6 位小数;0 表示改为不限额

请求体不能包含 sub_accountuser_enabled 或其他字段。

请求示例

curl --request PATCH \
  --url 'https://api-test.puraroute.com/gin/open-api/v1/dynamic/accounts/1912345678901234567' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <YOUR_API_KEY>' \
  --data '{
    "limit_traffic_gb": "20.000000"
  }'

响应参数

字段 类型 可为空 说明
id string 动态子账号 ID
sub_account 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 状态变更是否仍在生效过程中
update_time string 更新时间,GMT+8 ISO-8601

成功响应示例

{
  "code": 0,
  "msg": "success",
  "data": {
    "id": "1912345678901234567",
    "sub_account": "team_a_01",
    "limit_traffic_gb": "20.000000",
    "lifetime_used_gb": "1.250000",
    "resource_status": "ACTIVE",
    "user_enabled": true,
    "flow_blocked": false,
    "available": true,
    "control_pending": false,
    "update_time": "2026-08-24T15:40:00.000+08:00"
  },
  "next": null
}

可能的错误码

code 说明
300001 账号不存在或不可访问
300328 账号已移除,不能继续修改
400001 认证失败
400009 限额、路径或请求体不符合要求
500000 系统处理失败,请求未完成

On this page