设置带宽封顶
设置带宽封顶
接口描述
注意:本接口不再维护更新,请使用最新的用量封顶功能
本接口用于设置带宽封顶配置。带宽封顶功能本质上是一个触发器,当用户带宽达到指定值时自动触发stop域名或者访问403操作,操作触发后不可自动恢复,需要用户手动恢复
权限说明
所有API的安全认证一律采用Access Key与请求签名机制。 Access Key由Access Key ID和Secret Access Key组成,均为字符串。 对于每个HTTP请求,使用下面所描述的算法生成一个认证字符串。提交认证字符串放在Authorization头域里。服务端根据生成算法验证认证字符串的正确性。 认证字符串的格式为bce-auth-v{version}/{accessKeyId}/{timestamp}/{expirationPeriodInSeconds}/{signedHeaders}/{signature}
。
- version是正整数。
- timestamp是生成签名时的UTC时间。
- expirationPeriodInSeconds表示签名有效期限。
- signedHeaders是签名算法中涉及到的头域列表。头域名之间用分号(;)分隔,如host;x-bce-date。列表按照字典序排列。(本API签名仅使用host和x-bce-date两个header)
- signature是256位签名的十六进制表示,由64个小写字母组成。
当百度智能云接收到用户的请求后,系统将使用相同的SK和同样的认证机制生成认证字符串,并与用户请求中包含的认证字符串进行比对。如果认证字符串相同,系统认为用户拥有指定的操作权限,并执行相关操作;如果认证字符串不同,系统将忽略该操作并返回错误码。
鉴权认证机制的详细内容请参见鉴权认证。
注意事项
当带宽封顶配置action触发后,不会主动恢复,需要用户手动恢复。如:threshold设置为1G,action为stop,则当带宽达到1G时改域名被stop,需要用户主动去start该域名,否则域名将一直处于stop状态。设置action deny 同理。另外,用户将 actived 主动设置为 true 触发 action 中的操作后也不会主动恢复,需要用户手动恢复。建议用户谨慎看待该配置
请求语法
Method | Path | 说明 |
---|---|---|
PUT | /v2/domain/{domain}/config?limitBandwidth | 设置带宽封顶配置 |
domain: CDN加速域名
请求头域
除公共头域外,无其它特殊头域。
请求参数(Request Body)
参数 | 可选 | 类型 | 说明 |
---|---|---|---|
limitBandwidth | 必选 | LimitBandwidth | 带宽封顶配置 |
LimitBandwidth类型说明
参数 | 可选 | 类型 | 说明 |
---|---|---|---|
enabled | 必选 | bool | 开启/关闭带宽封顶配置 |
threshold | 必选 | string | 带宽封顶阈值,带单位G,如"1G", "200G"。enable为true时必选 |
action | 必选 | string | 带宽达到阈值时触发的动作,值为deny/stop,"stop"表示stop加速域名,"deny"表示拒绝所有请求。当enabled为true时必选 |
actived | 必选 | bool | 主动设置是否执行action,当设置为true时,无论带宽是否达到阈值,当前周期都会触发action,当设置为false时,无论带宽是否达到阈值,当前周期都不会触发action |
响应头域
除公共头域外,无其它特殊头域
响应参数
参数 | 可选 | 类型 | 说明 |
---|---|---|---|
status | 必选 | string | 当前域名状态,设置配置后通常为OPERATING |
请求示例
PUT /v2/domain/myself.baidu.com/config?limitBandwidth HTTP/1.1
Host: cdn.baidubce.com
Content-Length: 17
Content-Type: application/json
{
"limitBandwidth": {
"enabled": true,
"threshold": "2G",
"action": "deny"
}
}
响应示例
HTTP/1.1 200 OK
Server: nginx/1.1.10
Date: Wed, 21 Jul 2021 08:32:34 GMT
Content-Type: application/json; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
X-Powered-By: PHP/7.2.28
x-bce-request-id: d58bb985-e61b-8d1-eaee-4422bff9e93e
{"status":"OPERATING"}