更新消费者配额规则
更新时间:2026-09-22
该接口用于更新指定消费者的 Token 配额上限和重置规则。
注意事项:
totalTokens和totalTokensNum传-1表示不限制。- 非
NONE周期的重置时间使用北京时间HH:mm格式;周重置日期 1~7 依次表示周一至周日,月重置日期取值为 1~28。 - 仅当重置周期、重置日期或重置时间发生变化时,
clearUsage=true才会清零当前已用量。
请求结构
Plain Text
1POST /?action=UpdateConsumerQuota HTTP/1.1
2Host: apigw-control.bj.baidubce.com
3Authorization: authorization string
4
5{
6 "consumerId": consumerId,
7 "resetCycle": resetCycle,
8 "resetDay": resetDay,
9 "resetTime": resetTime,
10 "totalTokens": totalTokens,
11 "totalTokensNum": totalTokensNum,
12 "clearUsage": clearUsage
13}
请求头域
除公共头域外,无其它特殊头域。
请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| consumerId | String | 是 | RequestBody参数 | 消费者 ID |
| resetCycle | String | 是 | RequestBody参数 | 重置周期:NONE / DAILY / WEEKLY / MONTHLY |
| resetDay | int | 否 | RequestBody参数 | 重置日:WEEKLY 为 1-7(周一至周日),MONTHLY 为 1-28 |
| resetTime | String | 否 | RequestBody参数 | 每日重置时间,格式 HH:mm |
| totalTokens | long | 是 | RequestBody参数 | Token 配额总量,-1 表示不限制 |
| totalTokensNum | long | 是 | RequestBody参数 | 请求次数配额总量,-1 表示不限制 |
| clearUsage | Boolean | 否 | RequestBody参数 | 是否清空已使用量,仅在变更重置周期时生效 |
返回头域
除公共头域,无其它特殊头域。
返回参数
无特殊返回参数。
错误码
| 错误码 | 错误描述 | HTTP状态码 | 中文解释 |
|---|---|---|---|
| MethodArgumentNotValidException | MethodArgumentNotValidException: consumerId must not be blank | 400 | 必填参数缺失或格式不合法,consumerId 不能为空 |
| HttpMessageNotReadable | Http Message Not Readable: JSON parse error | 400 | 请求体不是合法 JSON,无法解析,请检查 JSON 语法和字段类型 |
| ResourcePermissionDeny | Resource permission deny. | 401 | 无权限访问指定资源,请确认使用正确的账号凭证且资源属于当前账号 |
| ConsumerNotExist | Consumer not exist. | 404 | consumerId 对应的消费者不存在、不属于当前账号或已删除 |
| ParamCheckError | resetTime is required when resetCycle is not NONE. | 404 | 配额参数不合法:周期非 NONE 时必须传 resetTime |
| ParamCheckError | resetDay must be between 1 and 7 when resetCycle is WEEKLY. | 404 | 配额参数不合法:WEEKLY 周期 resetDay 取值 1-7 |
| ParamCheckError | resetDay must be between 1 and 28 when resetCycle is MONTHLY. | 404 | 配额参数不合法:MONTHLY 周期 resetDay 取值 1-28 |
| HttpMediaTypeException | HttpMediaTypeException: Content-Type 'text/plain' is not supported | 415 | 请求的 Content-Type 不受支持,请使用 application/json |
请求示例
Plain Text
1POST /?action=UpdateConsumerQuota HTTP/1.1
2Host: apigw-control.bj.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
4
5{
6 "consumerId": "consumer-a1b2c3d4",
7 "resetCycle": "DAILY",
8 "resetTime": "00:00",
9 "totalTokens": 10000000,
10 "totalTokensNum": -1,
11 "clearUsage": false
12}
返回示例
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Wed, 03 Dec 2014 06:42:19 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6
7{}
评价此篇文章
