更新带宽限制配置--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

更新带宽限制配置

最近更新时间：2024.11.15 10:51:48首次发布时间：2023.05.18 17:30:36

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

注意事项

前提条件：带宽限制为白名单功能，请提交工单联系技术支持为您的账号开启配置能力。
请求频率：单用户请求频率限制为 10 次/秒。
超时时间：5 秒。
服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

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

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

Query

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

Body

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

BandwidthLimit

参数	类型	是否必选	示例值	描述
enabled	Boolean	是	`true`	是否开启带宽限制功能，取值如下所示： `true`：开启 `false`：关闭说明仅当 `enabled` 为 `true` 时，`threshold`、`limit_type` 等配置项有效。
threshold	Integer	是	`1000000000`	全局带宽阈值，指定加速域名的带宽阈值。单位为 bps，取值范围为 [1, 1000000000000000] 的整数。单位换算：1 Gbps = 1000 Mbps。
limit_type	String	是	`downloadspeedlimit`	控制策略类型，取值如下所示： `downloadspeedlimit`：单链接限速，先将每个请求的最大数据传输速度限制在 SpeedLimitRateMax，然后逐步降低该最大速度。 `speedlimit`：IP 限速，将每个 IP 地址的最大数据传输速度限制在 SpeedLimitRateMax，并且逐步降低该最大速度。对于每个 IP 地址，其最大数据传输速度会平均分摊到来自该 IP 地址的每个请求。 `randomreject`：拒绝请求，不会限制其正在响应的请求的最大速度，但是会随机拒绝新的请求。
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 + 4,194,304。单位换算：1 KB/S = 1024 B/S。当 `limit_type` 为 `downloadspeedlimit` 时，表示每个请求的初始最大速度。当 `limit_type` 为 `speedlimit` 时，表示每个 IP 地址的初始最大速度。说明当 `limit_type` 为 `randomreject` 时，不支持自定义该配置。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
msg	String	`submit domain:a.imagex.cn update request succeed`	通知描述

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateImageDomainBandwidthLimit&Version=2018-08-01&ServiceId=服务ID
{
    "domain": "a.imagex.cn",
    "bandwidth_limit": {
        "enabled": true,
        "threshold": 1000000000,
        "limit_type": "downloadspeedlimit",
        "speed_limit_rate": 1,
        "speed_limit_rate_max": 1
    }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "UpdateImageDomainBandwidthLimit",
        "Version": "2018-08-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "msg": "submit domain:a.imagex.cn update request succeed"
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。