文档中心 API文档 修改访问限速配置

修改访问限速配置

更新时间:2023-06-13 15:07:11

适用产品

网页加速、下载分发、动态加速、全站加速、点播分发、直播分发、上传加速、移动加速、上网加速、S-P2P、PCDN、应用性能管理、WEB应用防火墙、BotGuard爬虫管理、WSS、DMS、DDoS云清洗、IPv6一体化解决方案、电商安全加速解决方案、金融安全加速解决方案、政企安全加速解决方案、应用安全解决方案、区块链安全加速解决方案、IPv6安全加速解决方案

接口描述

修改访问限速配置

推荐使用 Open API在线调试

Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试

请求参数

Path 参数

参数名称类型必填描述
domain-name
String需要查询配置的域名或域名id

Body 参数

参数名称类型必填描述
access-speed-rules
List访问限速配置 1.需要访问限速时,此项必填 2.只有空标签access-speed-rules时清空访问限速配置
path-pattern
Stringurl匹配模式,支持正则,如果是全部匹配,入参可以配置为:.*
limit-mode
String限速方式,可按开始大小(单位KB)或开始时间(单位:s)限速,两者互斥 允许值:size/time
start-size
String开始限制字节,单位KB,从多少字节后开始限制,0表示不限制 limit-mode为size时,此项必填,start-time清空
start-time
String开始限制时间,单位S,从建连后多长时间后开始限制,0表示不限制 limit-mode为time时,此项必填,start-size清空
start-speed
String开始限制之前的速率,单位KB/S
priority
String优先级,填写整数,当配置多条时数字大的优先
speed
String限速值,指限制之后的速率,稳定速率,单位KB/S
data-id
Long配置多组配置时,具体某组配置的id。本功能只支持一组配置。dataId可以通过查询接口获取。 注意: a、如果有传dataId,说明指定修改该组配置项内容; b、如果入参都没有传dataId,表示用本次的配置全量覆盖原先配置; c、如果一组配置没有具体的配置项,则dataId必填,且值为实际存在的dataId,表示清空这个dataId对应配置项的值;不允许一组配置没有具体的配置项也没有dataId。

返回参数

响应头

参数名称类型描述
http status code
Integerhttpstatus=202;   表示成功调用新增域名接口,可使用header中的x-cnc-request-id查看当前新增域名的部署情况
x-cnc-request-id
String唯一标示的id,用于查询每次请求的任务 (适用全部接口)

Body 参数

参数名称类型描述
code
String错误代码,当HTTPStatus不为202时出现,表示当前请求调用的错误类型
message
String响应信息,成功时为success

错误码

错误代码(code)描述(message)HTTP状态码语义
26938005Error parameter.400入参解析错误
26938005The specified limit-mode is blank.400limit-mode不能为空
26938005The limit-mode is invalid.400limit-mode不在取值范围内(size/time)
26938005The start-time is invalid.400start-time不是整数
26938005The start-speed is invalid.400start-speed不是整数
26938005The specified start-size is required while limit-mode is size.400limit-mode为size时,此项必填,start-time清空
26938005The specified start-time is required while limit-mode is time.400limit-mode为time时,此项必填,start-size清空
26938005No access-speed-rules was specified.400access-speed-rules为空

示例

JSON
XML
JSON
请求示例
复制代码 复制成功
#!/bin/bash
username="example_username"
apiKey="example_apiKey"
date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"`
password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64`
curl -i --url "https://open.chinanetcenter.com/api/config/accessspeed/123344" \
-X "PUT" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json" \
-H "Content-Type:application/json" \
-d '
{
 "access-speed-rules":[
        {
            "data-id":"1",
            "path-pattern":".*",
            "limit-mode":"size",
            "start-size":"0",
            "start-time":"",
            "start-speed":"1000",
            "speed":"1000",

            "priority":"10"
        }
    ]
}'
返回示例
复制代码 复制成功
HTTP/1.1 202 Accepted
Date: Sun, 05 May 2019 09:08:53 GMT
Content-Type: application/xml;charset=utf-8
x-cnc-request-id: 83bbebc7-2c95-47d7
<response>
  <code>0</code>
  <message>success</message>
  <data></data>
</response>
本篇文档内容对您是否有帮助?
有帮助
我要反馈
提交成功!非常感谢您的反馈,我们会继续努力做到更好!