本接口支持通过指定服务 ID 和域名更新带宽限速相关配置,如带宽阈值、控制策略等。
说明
veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址。
以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | UpdateImageDomainBandwidthLimit | 接口名称 |
Version | String | 是 | 2018-08-01 | 接口版本 |
ServiceId | String | 是 |
| 服务 ID。
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
domain | String | 是 | a.imagex.cn | 域名。您可以通过调用 GetServiceDomains 接口获取域名。 |
bandwidth_limit | Object of bandwidth_limit | 是 | 带宽限制设置 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
enabled | Boolean | 是 |
| 是否开启带宽限制功能,取值如下所示:
说明 仅当 |
threshold | Integer | 是 |
| 全局带宽阈值,指定加速域名的带宽阈值。单位为 bps,取值范围为 [1, 1000000000000000] 的整数。 |
limit_type | String | 是 |
| 全局带宽阈值,指定加速域名的带宽阈值。单位为 bps,取值范围为 [1, 1000000000000000] 的整数。 |
speed_limit_rate | Integer | 是 |
| 设置节点响应访问请求的速度下限,在 veImageX 逐步降低最大速度的过程中,最大速度不会低于该配置。
说明 当 |
speed_limit_rate_max | Integer | 是 |
| 初始速率,即初始最大速度。限速发生时, veImageX 会从该速度开始,逐步降低最大速度。
说明 当 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
msg | String | submit domain:a.volcimagex.cn update request succeed | 通知描述 |
POST https://imagex.volcengineapi.com/?Action=UpdateImageDomainBandwidthLimit&ServiceId=%E6%9C%8D%E5%8A%A1ID&Version=2018-08-01 { "domain": "a.imagex.cn", "bandwidth_limit": { "enabled": true, "threshold": 1000000000, "speed_limit_rate": 1, "speed_limit_rate_max": 1, "limit_type": "downloadspeedlimit" } }
{ "ResponseMetadata": { "RequestId": "201806041104200100100232280022D30", "Action": "UpdateImageDomainBandwidthLimit", "Version": "2018-08-01", "Service": "imagex", "Region": "cn-north-1", }, "Result":{ msg: "submit domain:a.imagex.cn update request succeed" } }