文档中心 API文档 查询访问限速配置

查询访问限速配置

更新时间:2023-06-13 15:12:35

适用产品

网页加速、下载分发、全站加速、应用安全加速解决方案、IPv6一体化解决方案、电商安全加速解决方案、金融安全加速解决方案、政企安全加速解决方案、应用安全解决方案、区块链安全加速解决方案、IPv6安全加速解决方案、点播分发、直播分发、移动加速

接口描述

通过接口自助查询访问限速配置

  • 调用URL: https://open.chinanetcenter.com/api/config/accessspeed/*
  • 调用方法:GET
  • 限制说明:·在中国 加速域名必须已备案完成。 · 加速域名必须不包含如下信息:出售药物和管制刀具类,含有不法言论、信息。 · 视频类加速域名必须有视听许可证;博客论坛或社区类加速域名必须有BBS专项审批资质。 · 接口请求和返回结果接受xml和json格式。
推荐使用 Open API在线调试

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

请求参数

Path 参数

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

返回参数

Body 参数

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

错误码

错误代码(code)描述(message)HTTP状态码语义
InvalidParameterNo domain was specified.400没有指定域名
NoSuchDomainThe specified domain does not exist.404域名不存在
CustomerNoOwnDomaincustomer not own domain name[xxx]400客户没有该域名

示例

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 "GET" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json" \
-H "Content-Type:application/json"
返回示例
复制代码 复制成功
HTTP/1.1 200 OK
Date: Sun, 05 May 2019 09:08:53 GMT
Content-Type: application/json;charset=utf-8
x-cnc-request-id:83bbebc7-2c95-47d7
{
 "domain-name":"www.example.com",
 "domain-id":"123344",
 "access-speed-rules":[
        {
            "data-id":"1",
            "path-pattern":".*",
            "limit-mode":"size",
            "start-size":"0",
            "start-time":"",
            "start-speed":"1000",
            "speed":"1000",
            "priority":"10"
        }
    ]
}
本篇文档内容对您是否有帮助?
有帮助
我要反馈
提交成功!非常感谢您的反馈,我们会继续努力做到更好!