为指定成员设置个人用量限额,包括 TRAE 内置模型和企业内置模型的限额配置。
quota:write
0:将该成员在对应维度的用量限额设置为“不限制”。此时,该成员不再受该维度企业人均用量限额约束,但仍受企业整体用量限额或共享额度池总额约束。确认企业当前的限额配置颗粒度(quota_granularity),该配置将决定本接口中可生效的限额参数。
quota_granularity 为 per_model。quota_granularity 为 all。quota_granularity 仍可能为 all,只是尚未设置具体数值。
| 参数 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
emails |
string[] | 条件必填 | 待设置用量限额的成员的邮箱。与 user_ids 至少传入一个。邮箱不区分大小写。 |
|
|
string[] |
条件必填 |
待设置用量限额的成员的用户 ID。与 你需要调用 “获取成员列表” 接口来获取成员的用户 ID,详情参考获取成员列表。 |
|
|
string |
是 |
企业当前对 TRAE 内置模型采用的用量计算模式。取值:
|
|
|
int64 |
否 |
该成员可用的基础会话额度。 取值范围:[0, 企业整体限额]。取值为 该额度来自共享额度池,仅对旗舰版套餐和 TRAE 内置模型生效。详情参考共享额度池。 |
|
|
int64 |
否 |
成员使用 TRAE 内置模型时,可用的全部模型总超额会话额度。 取值范围:[0, 9999999998]。取值为 提示:仅当 |
|
|
array |
否 |
成员使用 TRAE 内置模型时,指定单个模型可用的超额会话额度。 提示:仅当 |
trae_model_excess_quota.name |
string | 是 | TRAE 内置模型的展示名,区分大小写,须与模型列表中的名称完全一致。 |
|
|
int64 |
是 |
成员在指定 TRAE 内置模型中可用的超额会话额度。 旧企业版套餐的单位为 Token,新企业版套餐的单位为元。 取值范围:[0, 9999999998]。取值为 |
custom_model_excess_quota |
array | 否 | 成员使用企业内置模型时,可用的额度。该参数生效与否不受 quota_granularity 限制。 |
custom_model_excess_quota.name |
string | 是 | 企业内置模型的展示名,区分大小写,须与模型列表中的名称完全一致。 |
|
|
int64 |
是 |
成员在指定企业内置模型中可用的额度,单位为 Token。 取值范围:[0, 9999999998]。取值为 |
emails 和 user_ids 参数。系统会根据邮箱或用户 ID 解析成员,并对重复成员自动去重。去重后,单次请求最多支持传入 50 个成员。total_excess_quota 与 trae_model_excess_quota 参数互斥,单次请求只能传入其中一个。请根据企业当前的 quota_granularity 类型选择对应参数。basic_quota、total_excess_quota、trae_model_excess_quota 或 custom_model_excess_quota,否则请求将失败。0 或正整数,否则请求将失败。name 参数中不得传入重复的模型名称,否则请求将失败。当 trae_model_quota_type 为 token 时,系统会将正数限额值按 10000 Token 的精度向下取整。建议所有以 Token 为单位的限额值均传入 10000 的整数倍,以避免精度损失。
所传入的成员的个人用量限额都更新成功时,该接口仅返回通用响应参数。参数说明参考通用响应格式。
若仅部分成员的用量限额更新成功,该接口会返回以下特有参数:
| 参数 | 类型 | 描述 |
|---|---|---|
succeeded_users |
string[] | 个人用量限额更新成功的成员的用户 ID 列表。 |
failed_users |
string[] | 个人用量限额更新失败的成员的用户 ID 列表。 |
error_detail |
string | 错误说明。 |
仅修改可用的总超额会话额度:
curl -X POST "${HOST}/openapi/v1/quota/set_user_usage_quota" \
-H "Authorization: Bearer ${ACCESS_TOKEN}" \
-H "Content-Type: application/json" \
-d '{
"user_ids": ["123456789012345678"],
"trae_model_quota_type": "token",
"total_excess_quota": 50000000
}'
全部更新成功:
{
"code": 0,
"message": "success",
"request_id": "req_abc123xyz",
"data": null
}
部分更新成功:
{
"code": 60110,
"message": "partial success",
"request_id": "req_abc123xyz",
"data": {
"succeeded_users": ["123456789012345678"],
"failed_users": ["223456789012345678"],
"error_detail": "update quota failed"
}
}
关于该接口可能返回的错误码,参考错误码。