文档中心 API文档 查询域名下多级目录的带宽及总流量

查询域名下多级目录的带宽及总流量

更新时间:2022-07-07 17:24:11

适用产品

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

接口描述

查询多域名下多级目录的带宽及总流量,主要是网页,下载,点播域名。

推荐使用 Open API在线调试

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

请求参数

Body 参数

参数名称类型必填描述
dateFrom
String开始时间 1.格式为yyyy-MM-ddTHH:mm:ss+08:00; 2.必须小于当前时间和dateTo; 3.dateFrom和dateTo相差不能超过31天(可联系技术支持调整); 4.只能查询最近半年内数据。
dateTo
String结束时间 1.格式为yyyy-MM-ddTHH:mm:ss+08:00; 2.必须大于dateFrom; 3.如果大于当前时间,则重新赋值为当前时间;
dirHierarchy
String目录层级,取值范围1~4,只能提交单个值
domainDir
Listundefined
domain
String域名 1.需要满足域名的正则校验; 2.域名个数限制根据账号可调,默认为1个;
dir
List目录 1.目录个数限制根据账号可调,默认为200个; 2.不传代表查询该域名下的所有目录,同时接受目录个数限制; 3.无效的目录不返回

返回参数

Body 参数

参数名称类型描述
result
List结果
domain
String域名
details
List详情数据
dir
String对应层级的目录名称
totalFlow
String总流量,单位MB,保留2位小数
bandwidthPeakValue
String带宽峰值,单位Mbps,保留2位小数

错误码

错误代码(code)描述(message)HTTP状态码语义
InvalidHTTPRequestThere   was an error in the body of your HTTP request.400请求体格式错误
InvalidDatePeriodThe   date specified is invalid.400dateFrom或dateTo不符合规范
DateSpanErrorYou   cannot specify a period greater than 31.400dateFrom和dateTo相差超过31天
NoSuchDomainThe   specified domain does not exist.404传递的域名不存在
DomainsExcessiveThe   number of domain is excessive once.403传递的域名个数超过账号限制
DirExcessiveThe   number of dir is excessive once.403传递的目录个数超过账号限制
PARAM_INVALIDparam:   dir is null or invalid.400参数dir不符合规范
InternalErrorWe   encountered an internal error. Please try again.500系统发生错误
PARAM_INVALIDparam: dirHierarchy is null or invalid.400参数dirHierarchy不符合规范
PARAM_INVALIDparam: domainDir is null or invalid.400参数domainDir不符合规范
PARAM_INVALIDparam: domain is null or invalid.400参数domain不符合规范

示例

JSON
XML
JSON
请求示例
复制代码 复制成功
#!/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/flow/dir/info" \
-X "POST" \
-H "X-Time-Zone:GMT+08:00" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json" \
-d '{
    "dateFrom":"2017-06-17T23:59:00+08:00",
    "dateTo":"2017-06-19T16:40:00+08:00",
    "dirHierarchy":"1",
    "domainDir":[
        {
            "domain":"test.com",
            "dir":[
                "/dir01/",
                "/dir02/"
            ]
        }
    ]
}'
返回示例
复制代码 复制成功
{
      "result":[
          {
                "domain":"test.com",
                "details":[
                  {
                        "dir":"dir01",
                        "totalFlow":"1000065.00",
                        "bandwidthPeakValue":"2666.96"
                  },
                  {
                      "dir":"dir02",
                        "totalFlow":"2000130.00",
                        "bandwidthPeakValue":"2666.96"
                  }
              ]
          }
      ]
  }
本篇文档内容对您是否有帮助?
有帮助
没帮助
提交成功!非常感谢您的反馈,我们会继续努力做到更好!