客户管理/启用部门余额限流
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
PUT /api/v1/modelRouter/open/clients/{id}/balance HTTP/1.1
路径参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| id |
integer |
否 |
部门 ID |
1 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| body |
object |
否 |
请求 body 参数 |
|
| enableBalance |
boolean |
否 |
是否启用余额限流,余额一旦开启不可关闭 |
true |
| balanceType |
string |
否 |
余额类型:amount(金额)/ tokens(token 数量),首次启用时必填,一旦设置不可修改 |
amount |
| initialBalance |
number |
否 |
初始余额,仅在首次启用时生效 |
100.00 |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
OpenApiSingleResponse |
{ "success": true, "data": {"id": 1, "client_id": 1, "balance": 100.00, "balance_type": "amount", "enable_balance": true}, "requestId": "592A27EF-26D3-1434-98C1-97AD63337852" } |
|
| requestId |
string |
请求编号 |
xxxx-xxxx-xxxx-xxxxxxxx |
| success |
boolean |
是否成功 |
true |
| errCode |
string |
错误信息编码 |
UNKNOWN_ERROR |
| errMessage |
string |
错误信息 |
未知错误 |
| httpStatusCode |
integer |
http 状态码 |
200 |
| data | ClientBalanceDTO |
数据对象 |
{} |
示例
正常返回示例
JSON格式
{
"requestId": "xxxx-xxxx-xxxx-xxxxxxxx",
"success": true,
"errCode": "UNKNOWN_ERROR",
"errMessage": "未知错误",
"httpStatusCode": 200,
"data": {
"id": 1,
"clientId": 1,
"balance": 100,
"balanceType": "amount",
"enableBalance": true,
"gmtCreate": "2024-01-01T00:00:00Z",
"gmtModified": "2024-01-01T00:00:00Z"
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | B.Validation.InvalidParameterException | 请求参数无效 | |
| 500 | Server.Internal.UnknownError | The request processing has failed due to some unknown error. | |
| 403 | B.Permission.DeniedException | 鉴权失败或权限不足 | |
| 403 | B.Permission.OrgNoExistException | 组织不存在,请主账号开通权限后再试,或联系管理员 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。