CDN加速

文档中心 API文档 频道带宽接口

频道带宽接口

更新时间:2022-01-04 10:36:39

适用产品

Web应用防火墙、移动加速、下载分发、动态加速、政企安全加速解决方案、电商安全加速解决方案、应用安全加速解决方案、全站加速、上网加速、上传加速、点播分发、网页加速、金融安全加速解决方案、应用安全解决方案、应用加速

接口描述

查询域名带宽(域名、分钟粒度的带宽)

推荐使用 Open API在线调试

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

请求参数

Body 参数

参数名称类型必填描述
cust
String合并账号下的某个客户的英文名,当合并账号要查看子客户的信息时,必须填写子客户的英文名
date
String查询的日期,日期格式为yyyy-mm-dd,不选或者为空时默认为当天;
startdate
String查询的起始日期,精确到分钟,日期格式为yyyy-mm-dd hh:MM若没有输入时、分,则时分默认为00:01;此参数需与enddate参数配合,若存在date参数,则该参数无效
enddate
String查询的结束日期,精确到分钟,日期格式为yyyy-mm-dd hh:MM,若没有输入时、分,则时分默认为24:00;此参数需与startdate参数配合,若存在date参数,则该参数无效。
channel
String查询的频道,多个频道值请用英文分号';',不选或者为空时默认为所查询客户的所有频道
region
String查询的加速区域的缩写,多个区域请用英文分号';'分隔开,如查询大陆及亚太区域,参数填写为:'region=cn;apac'。不选或者为空时默认为全部区域。
accetype
String加速类型参数,如accetype=web。多个请用英文分号';'分隔开,不填或值为all表示所有类型
dataformat
String返回结果格式,支持格式为xml和json,默认为xml
isExactMatch
String 频道是否完全匹配,为true时,必须填写完整的域名(此时会过滤用户输入的无效或重复频道,所有输入频道都无效时返403)。不为true时,显示以用户输入的频道为结尾的所有频道。默认为true
isp
String 要查询的运营商的缩写,多个isp请用英文分号';'分隔开。运营商的缩写格式参考附录:具体运行商(ISP)信息的代号。备注:只有当地区只写了'cn'时,填写isp信息才有效。不选或者为空时默认为所有isp。
resultType
String 结果的显示是否提供合并值。填写1时:只提供合并结果;填写2时:只提供拆分值;填写3时:既提供合并值,又提供拆分值。不选或者为空时默认为'1'。
needFlow
StringneedFlow 是否需要返回流量明细,1:需要;0:不需要。默认为0.
optionalFields
StringflowInfo :展示带宽峰值、峰值时间、总流量信息;

返回参数

Body 参数

参数名称类型描述
provider
BandwidthChannelResponseProvider结果
name
String租户
type
String接口类型
resultType
String统计类型
date
BandwidthChannelResponseProviderDate频道带宽数据
startdate
String开始时间
enddate
String结束时间
channel
BandwidthChannelResponseProviderDateChannel频道
name
String频道
bandwidth
List带宽数据
time
String时间点
text
String带宽

示例

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/myview/bandwidth-channel" \
-X "POST" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/xml" \
-d "channel=test.com&startdate=2018-02-02&enddate=2018-02-03&dataformat=json"
返回示例
复制代码 复制成功
{
    "provider":{
        "name":"${ProviderName}",
        "type":"bandwidth-channel",
        "resultType":"1",
        "date":{
            "name":"2017-06-16",
            "channel":{
                "name":"www.test.com",
                "bandwidth":[
                    {
                        "time":"2017-06-16 00:00:00",
                        "text":"1.85709"
                    },
                    {
                        "time":"2017-06-16 00:05:00",
                        "text":"4.10254"
                    },
                    {
                        "time":"2017-06-16 00:10:00",
                        "text":"6.25884"
                    },
                    {
                        "time":"2017-06-16 00:15:00",
                        "text":"4.30233"
                    },
                    {
                        "time":"2017-06-16 00:20:00",
                        "text":"6.30809"
                    },
                    {
                        "time":"2017-06-16 00:25:00",
                        "text":"408.31129"
                    }
                ]
            }
        }
    }
}