You need to enable JavaScript to run this app.
导航
更新下载限速配置
最近更新时间:2024.01.31 15:08:47首次发布时间:2023.05.18 17:30:36

本接口支持通过指定服务 ID 和域名更新下载限速相关配置。

注意事项

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

请求说明

  • 接口名称:UpdateImageDomainDownloadSpeedLimit
  • 请求方式:POST
  • 请求地址示例:https://imagex.volcengineapi.com/?Action=UpdateImageDomainDownloadSpeedLimit&Version=2018-08-01

说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringUpdateImageDomainDownloadSpeedLimit接口名称
VersionString2018-08-01接口版本

ServiceId

String

uh****2h

服务 ID。

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

Body

参数类型是否必选示例值描述
domainStringa.imagex.cn域名。您可以通过调用 GetServiceDomains接口获取域名。
download_speed_limitObject of download_speed_limit下载限速配置

download_speed_limit

参数类型是否必选示例值描述
rulesObject of rules限速规则配置

enabled

Boolean

true

是否开启下载限速功能,取值如下所示:

  • true:开启
  • false:关闭

说明

仅当 enabledtrue 时,rules 等配置项有效。

rules

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

match_type

String

filetype

规则类型,取值如下所示:

  • filetype:文件后缀,限速规则应用于特定后缀名的所有文件。
  • directory:目录,限速规则应用于特定目录下的所有文件。
  • path:文件全路径,限速规则应用于特定文件。
  • unlimited:全部文件,限速规则应用于所有文件。

match_value

String

png

规则内容,根据指定的规则类型进行输入。不能超过 1024 个字符。输入多个配置时以英文分号(;)分隔。

  • match_typefiletype时,文件后缀规则支持填充多个,以英文分号(;)分隔。如 jpg;png
  • match_typedirectory时,目录匹配规则需要以 / 开头和结尾,多个目录之间以英文分号(;) 分隔。如/test/a/;/test/b/
  • match_typepath时,全路径匹配需要以 / 开头,支持通配符 *,多个路径之间以英文分号(;)分隔。如/test/1.jpg;/test/2.jpg

说明

match_typeunlimited时,match_value配置无效。

limit_rate

Integer

200

下载速度的限速值。单位:B/S,取值范围为 [1,1073741824000000] 的整数。
单位换算:1 KB/S = 1024 B/S。

limit_rate_after

Integer

10000

限速开始前的下载数据量。单个请求的下载量未达到该自定义值时,请求不会被限速。达到阈值后,请求将被限速。
单位:Byte,取值范围为 [1,1073741824000000] 的整数。
单位换算:1 KB = 1024 B。

说明

limit_rate_after 指定为 0 时,表示从资源的第一个字节就开始下载限速。

day_week

String

unlimited

限速发生日期,输入多个时以英文分号(;)分隔。取值如下所示:

  • unlimited:每天
  • monday:星期一
  • tuesday:星期二
  • wednesday:星期三
  • thursday:星期四
  • friday:星期五
  • saturday:星期六
  • sunday:星期日

注意

unlimited 仅可单独指定,禁止与其他枚举值一起使用。

begin_time

String

00:00

限速开始时间段,时间格式是 mm:ss,精确到分钟。如 00:00

说明

如果 begin_timeend_time 为空,会默认设置成 00:0023:59

end_time

String

23:59

限速结束时间段,时间格式是 mm:ss,精确到分钟。如23:59

说明

如果 begin_timeend_time 为空,会默认设置成 00:0023:59

返回参数

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

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=UpdateImageDomainDownloadSpeedLimit&ServiceId=%E6%9C%8D%E5%8A%A1ID&Version=2018-08-01
{
  "domain": "a.imagex.cn",
  "download_speed_limit": {
    "enabled": true,
    "rules": [
      {
        "match_type": "filetype",
        "match_value": "png",
        "limit_rate": 200,
        "limit_rate_after": 10000,
        "day_week": "unlimited",
        "begin_time": "00:00",
        "end_time": "23:59"
      }
    ]
  }
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "UpdateImageDomainBandwidthLimit",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
    },
    "Result": {
        msg: "submit domain:a.volcimagex.cn update request succeed"
    }
}

错误码

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