设置用量封顶
更新时间：2025-07-21
设置用量封顶
接口描述
本接口用于设置用量封顶配置，可选择带宽、流量、QPS、PV 中的一项进行设置。
| Method | Path | 说明 |
|---|---|---|
| PUT | /v2/domain/{domain}/config?limitConsumption | 设置用量封顶配置 |
其中，domain : 表示 CDN 加速域名。
注意事项
当用量封顶配置 action 触发后，如果没有设置自动恢复，需要用户手动恢复。如：threshold 设置为1Gbps，action 设置为 stop，当带宽达到 1Gbps 时域名被 stop，需要用户主动去 start 该域名，否则域名将一直处于 stop 状态。当 action 值为 deny 时同理。
请求头域
除公共头域外，无其它特殊头域。
请求体（Request Body）
| 参数名称 | 可选 | 类型 | 说明 |
|---|---|---|---|
| limitConsumption | 必选 | LimitConsumption | 用量封顶配置 |
LimitConsumption 类型说明
| 参数名称 | 参数类型 | 参数说明 |
|---|---|---|
| enabled | Bool | 开启/关闭用量封顶配置。enabled 值为 true 时，表示开启。 |
| activated | Bool | 是否已经触发阈值，执行 action。activated 值为 true 时，表示已触发。 |
| type | String | 检测类型，合法值为 flow、bandwidth、pv 或 qps。 |
| threshold | String | 检测阈值，type 不同时，单位不同。type 值为 flow 时，合法单位为 GB、TB 或 PB。type 值为 bandwidth 时，合法单位为 Mbps、Gbps 或 Tbps。type 值为 pv 或 qps 时，填写数值即可，如“1234”。 |
| statisticalCycle | Int | 检测周期，单位为秒，enable 值为 true 时必选。合法值为 300 、3600 或 86400。type 值为 bandwidth 或 qps 时，固定取值为 300。当type 值为 pv 或 flow 时，合法值为 3600 或 86400。 |
| action | String | 达到阈值时触发的动作，deny 或 stop。其中，stop 表示停止加速域名，deny 表示拒绝所有请求，访问会返回 404。 |
| recoverAfterSeconds | Int | 触发阈值，执行 action 后自动恢复的时间。单位为秒，enable 为 true 时必选。合法值为 -1 、3600 、86400或 259200，-1 表示不自动恢复，其他取值恢复时间存在一定延迟，最多延迟 10min。 |
| notification | List<String> | 触发阈值后的通知方式，分别为 sms（短信）、 mail（邮件）或 internal_message（站内信）。 |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 可选 | 类型 | 说明 |
|---|---|---|---|
| status | 必选 | String | 当前域名状态，设置配置后通常为 RUNNING。 |
请求示例1：带宽用量封顶
Plain Text
1PUT /v2/domain/myself.baidu.com/config?limitConsumption HTTP/1.1
2Host: cdn.baidubce.com
3Content-Length: 215
4Content-Type: application/json
5Accept: application/json
6Authorization: xxxxxx
7Content-Type: application/json
8x-bce-date: 2025-07-18T06:31:46Z
9x-bce-request-id: 05ce2f89-4dc4-4a45-8a36-f7d6aeaca9d9
10
11{
12 "limitConsumption":{
13 "type": "bandwidth",
14 "statisticalCycle": 300,
15 "recoverAfterSeconds": 3600,
16 "threshold": "10Gbps",
17 "enabled": true,
18 "action": "deny",
19 "notification": ["sms", "mail", "internal_message"]
20 }
21}请求示例2：pv用量封顶
Plain Text
1PUT /v2/domain/myself.baidu.com/config?limitConsumption HTTP/1.1
2Host: cdn.baidubce.com
3Content-Length: 215
4Content-Type: application/json
5Accept: application/json
6Authorization: xxxxxx
7Content-Type: application/json
8x-bce-date: 2025-07-18T06:32:56Z
9x-bce-request-id: 12df4h52-4dc4-4a45-8a36-f7d6aeaca9d9
10
11{
12 "limitConsumption":{
13 "type": "pv",
14 "statisticalCycle": 3600,
15 "recoverAfterSeconds": 3600,
16 "threshold": "100000",
17 "enabled": true,
18 "action": "stop",
19 "notification": ["sms", "mail", "internal_message"]
20 }
21}响应示例
Plain Text
1HTTP/1.1 200 OK
2Server: nginx/1.16.1
3Date: Fri, 18 Jul 2025 06:31:46 GMT
4Content-Type: application/json; charset=utf-8
5Transfer-Encoding: chunked
6Connection: keep-alive
7X-Powered-By: PHP/7.1.15
8x-bce-request-id: 05ce2f89-4dc4-4a45-8a36-f7d6aeaca9d9
9
10{
11 "status":"RUNNING"
12}