文档中心

更新带宽限制配置

最近更新时间：2024.01.31 15:08:34

首次发布时间：2023.05.18 17:30:36

本接口支持通过指定服务 ID 和域名更新带宽限速相关配置，如带宽阈值、控制策略等。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
超时时间：5 秒。

请求说明

请求名称：UpdateImageDomainBandwidthLimit
请求方式：POST
请求地址：（示例）https://imagex.volcengineapi.com/?Action=UpdateImageDomainBandwidthLimit&Version=2018-08-01

说明

veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

Query

参数类型是否必选示例值描述

Action String 是 UpdateImageDomainBandwidthLimit 接口名称

Version String 是 2018-08-01 接口版本

参数	类型	是否必选	示例值	描述
Action	String	是	`UpdateImageDomainBandwidthLimit`	接口名称
Version	String	是	`2018-08-01`	接口版本
ServiceId	String	是	`服务ID`	服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过调用 GetAllImageServices 接口方式获取服务 ID。

ServiceId

String

是

服务ID

服务 ID。

您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。
您也可以通过调用 GetAllImageServices 接口方式获取服务 ID。

Body

参数	类型	是否必选	示例值	描述
domain	String	是	`a.imagex.cn`	域名。您可以通过调用 GetServiceDomains 接口获取域名。
bandwidth_limit	Object of bandwidth_limit	是		带宽限制设置

bandwidth_limit

参数	类型	是否必选	示例值	描述
enabled	Boolean	是	`true`	是否开启带宽限制功能，取值如下所示： `true`：开启 `false`：关闭说明仅当 `enabled` 为 `true` 时，`threshold`、`limit_type` 等配置项有效。
threshold	Integer	是	`1000000000`	全局带宽阈值，指定加速域名的带宽阈值。单位为 bps，取值范围为 [1, 1000000000000000] 的整数。单位换算：1 Gbps = 1000 Mbps。
limit_type	String	是	`downloadspeedlimit`	全局带宽阈值，指定加速域名的带宽阈值。单位为 bps，取值范围为 [1, 1000000000000000] 的整数。单位换算：1 Gbps = 1000 Mbps。
speed_limit_rate	Integer	是	`1`	设置节点响应访问请求的速度下限，在 veImageX 逐步降低最大速度的过程中，最大速度不会低于该配置。单位：B/S，取值范围为 [1,1073741824000]的整数。单位换算：1 KB/S = 1024 B/S。当 `limit_type` 为 `downloadspeedlimit` 时，表示每个请求的最低速度。当 `limit_type` 为 `speedlimit` 时，表示每个 IP 地址的最低速度。说明当 `limit_type` 为 `randomreject` 时，不支持自定义该配置。
speed_limit_rate_max	Integer	是	`1`	初始速率，即初始最大速度。限速发生时， veImageX 会从该速度开始，逐步降低最大速度。单位：B/S，取值范围为[1,1073741824000]的整数。默认值为 `speed_limit_rate + 4194304` B/S。单位换算：1 KB/S = 1024 B/S。当 `limit_type` 为 `downloadspeedlimit` 时，表示每个请求的初始最大速度。当 `limit_type` 为 `speedlimit` 时，表示每个 IP 地址的初始最大速度。说明当 `limit_type` 为 `randomreject` 时，不支持自定义该配置。

返回参数

参数	类型	示例值	描述
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"
    }
}

错误码

访问公共错误码和域名相关错误码获取详细信息。