文档中心 API文档 查询多域名的带宽汇总

查询多域名的带宽汇总

更新时间:2022-09-19 16:13:20

适用产品

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

接口描述

获取指定多域名加速域名的带宽汇总报表。

推荐使用 Open API在线调试

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

请求参数

Params 参数

参数名称类型必填描述
datefrom
String开始时间 1.格式为yyyy-MM-ddTHH:mm:ss+08:00; 2.并且小于当前时间和dateTo; 3.dateFrom和dateTo相差不能超过31天(可联系技术支持调整);4.只能查询最近2年内数据。
dateto
String结束时间 1.格式为yyyy-MM-ddTHH:mm:ss+08:00; 2.必须大于dateFrom; 3.如果大于当前时间,则重新赋值为当前时间;
type
String数据粒度 1.fiveminutes:5分钟,hourly:1小时,daily:1天; 2.不传递,默认为daily; 3.传递fiveminutes时,若客户数据采集粒度有特殊配置将按实际配置粒度返回。

Body 参数

参数名称类型必填描述
domain-list
DomainList域名列表 1.域名个数限制根据账号可调,默认为20个(可联系技术支持下单调整);
domain-name
List域名

返回参数

Body 参数

参数名称类型描述
bandwidthReport
Listundefined
timestamp
String时间 1.查询的数据粒度为fiveminutes时,格式为yyyy-MM-dd HH:mm;每一个时间片数据值代表的是前一个时间粒度范围内的数据值。一天开始的时间片是yyyy-MM-dd 00:05,最后一个时间片是yyyy-MM-dd 24:00。 2.查询的数据粒度为hourly时,格式为yyyy-MM-dd HH;每一个时间片数据值代表的是前一个时间粒度范围内的数据值。一天开始的时间片是yyyy-MM-dd 01,最后一个时间片是yyyy-MM-dd 24。 3.查询的数据粒度为daily时,格式为yyyy-MM-dd;每一个时间片数据值代表的该天内的数据值; 4.返回开始时间和结束时间包含的时间片。
bandwidth
Integer带宽,保留4位小数,单位为Mbps

错误码

错误代码(code)描述(message)HTTP状态码语义
DomainNameIsRequiredThe   domain name is required.400请求体有传递且域名数组为空
NoSuchDomainThe   specified domain does not exist.404域名不存在,或不属于当前调用接口的账号
InvalidChannelAccess   to the specified resource (invalid channel) has been forbidden.403域名非法
InvalidDatePeriodThe date specified is invalid.400datefrom或dateto不符合规范
DateSpanErrorYou cannot specify a period greater than 31.400datefrom和dateto相差超过31天
InvalidReportTypeThe report type specified is invalid.400参数type不符合规范
DomainsExcessiveThe number of domain is excessive once.403传递的域名个数超过账号限制
ReportErrorreport error.400系统发生错误(myview接口返回错误,且错误码非200和403)
InternalErrorWe encountered an internal error. Please try again.503系统发生错误

示例

XML
JSON
XML
请求示例
复制代码 复制成功
#!/bin/bash
# 请将示例中的(-H "X-Time-Zone") 参数设置为您希望在返回结果中获得的时区
# Please remember to change the param (-H "X-Time-Zone") in this demo to the TimeZone you want in response
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/report/domainbandwidth?datefrom=2017-11-07T00:00:00%2B08:00&dateto=2017-11-07T00:10:00%2B08:00&type=fiveminutes" \
-X "POST" \
-H "X-Time-Zone:GMT+08:00" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/xml" \
-d '<?xml version="1.0" encoding="utf-8"?>
<domain-list>
  <domain-name>www.exapmle1.com</domain-name>
  <domain-name>www.exapmle2.com</domain-name>
</domain-list>'
返回示例
复制代码 复制成功
<?xml   version="1.0" encoding="utf-8"?>
  <bandwidth-report>
    <bandwidth-data>
      <timestamp>2017-11-07   00:05:00</timestamp>
        <bandwidth>12217.2046</bandwidth>
    </bandwidth-data>
    <bandwidth-data>
      <timestamp>2017-11-07   00:10:00</timestamp>
        <bandwidth>14424.9125</bandwidth>
    </bandwidth-data>
  </bandwidth-report>
本篇文档内容对您是否有帮助?
有帮助
没帮助
提交成功!非常感谢您的反馈,我们会继续努力做到更好!