CDN加速

文档中心 API文档 流量报表 查询多域名的流量请求数及峰值带宽

查询多域名的流量请求数及峰值带宽

更新时间:2021-04-15 16:17:29
适用产品:通用功能

接口描述

用于拉取短时间内的边缘节点的流量及请求数

请求参数

参数名称类型必填描述
dateFromstring开始时间: 1.时间格式为yyyy-MM-ddTHH:mm:ss+08:00,例如,2016-12-02T10:00:00+08:00(为北京时间2016年12月2日10点0分0秒); 2.不能大于当前时间 3.最多可获取最近半年(183天)的数据。
dateTostring结束时间: 1.时间格式2016-12-02T10:00:00+08:00 2.结束时间需大于开始时间,结束时间如果大于当前时间,取当前时间。 4.dateFrom,dateTo二者都未传,默认查询过去的24小时;如仅有一个未传,抛异常 5.允许查询最大时间间隔:1天,即dateFrom和dateTo相差不能超过1天(可联系技术支持调整)。
domainarray域名: 1、可传递域名数量上限默认为200个(可联系技术支持调整); 2、未传递该入参时查询账号下所有域名,但当账号下域名数量超过限制时不可查询(报错)。
groupByarray分组关键词: 1、默认聚合展示;   2、传入关键词则代表需要按照关键词对应的值展示明细; 例如groupBy传domain,则代表返回按照domain明细展开。 3、只能传递domain。
dataPaddingboolean是否补0 取值为true或false,默认为false 当dataPadding取值为true时,没有数据的时间点填充数据,取值为0 当dataPadding取值为false时,不做处理

返回参数

参数名称类型描述
domainstring域名
totalFlowstring总流量 单位:MB ,保留2位小数,示例 ( 74099.92 )
totalRequeststring总请求数
peakBandwidthstring峰值带宽,单位: Mbps,保留2位小数,示例 (931556.21)
peakTimestring峰值时间,示例(2019-02-13 18:01)
timestampstring时间片 1.查询的数据粒度为5m时,格式为yyyy-MM-dd HH:mm;每一个时间片数据值代表的是前一个时间粒度范围内的数据值。一天开始的时间片是yyyy-MM-dd 00:05,最后一个时间片是(yyyy-MM-dd+1) 00:00。 2.返回开始时间和结束时间包含的时间片。
flowstring流量值,单位MB,保留2位小数;
bandwidthstring带宽值,单位: Mbps,保留2位小数,示例 (931556.21)
requeststring请求数

错误码

错误代码(code)描述(message)HTTP状态码语义
MissingBodyThis   operation requires a body. Ensure that the body is present and the   Content-Type header is set.400请求体没有传递
NotAcceptableThe   accept header specified in your request is not acceptable.400Accept请求头不支持,接口仅支持json和xml格式,默认为json格式
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 30.400dateFrom和dateTo相差超过30分钟
PARAM_INVALIDparam:   domain is null or invalid.400参数domain不符合规范
NumberLimitExceededThe   request was rejected because the number of domain({actual}) exceeds the limit   ({expect})400传递的域名个数超过账号限制
InternalErrorWe   encountered an internal error. Please try again.500系统发生错误
PARAM_INVALIDparam: dataPadding is null or invalid.400dataPadding 不符合规范

示例

示例说明
请求示例
复制
#!/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-request" \
-X "POST" \
-H "X-Time-Zone:GMT+08:00" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json" \
-d '{"dateFrom": "2019-01-01T10:00:00+08:00","dateTo": "2019-01-02T10:00:00+08:00","domain": ["www.aaa.com","www.bbb.com","www.ccc.com"],"dataInterval": "5m","groupBy": ["domain"],"dataPadding":true
}'
返回示例
复制
{
    "result": [
        {
            "domain": "www.aaa.com",
            "totalFlow": "2289703.71",
            "totalRequest": "32124",
            "peakBandwidth": "289703.71",
            "peakTime": "2019-01-01 00:05",
            "flowRequestData": [
                {
                    "timestamp": "2019-01-01 00:05",
                    "flow": "123.21",
                    "bandwidth": "556.21",
                    "request": "123"
                },
                {
                    "timestamp": "2019-01-01 00:10",
                    "flow": "123.21",
                    "bandwidth": "556.21",
                    "request": "123"
                }
            ]
        },
        {
            "domain": "www.bbb.com",
            "totalFlow": "2289703.71",
            "totalRequest": "32124",
            "peakBandwidth": "289703.71",
            "peakTime": "2019-01-01 00:05",
            "flowRequestData": [
                {
                    "timestamp": "2019-01-01 00:05",
                    "flow": "123.21",
                    "bandwidth": "556.21",
                    "request": "123"
                },
                {
                    "timestamp": "2019-01-02 00:10",
                    "flow": "123.21",
                    "bandwidth": "556.21",
                    "request": "123"
                }
            ]
        },
        {
            "domain": "www.ccc.com",
            "totalFlow": "0.00",
            "totalRequest": "0",
            "peakBandwidth": "0.00",
            "peakTime": "2019-01-01 00:05",
            "flowRequestData": [
                {
                    "timestamp": "2019-01-01 00:05",
                    "flow": "0.00",
                    "bandwidth": "0.00",
                    "request": "0"
                },
                {
                    "timestamp": "2019-01-02 00:10",
                    "flow": "0.00",
                    "bandwidth": "0.00",
                    "request": "0"
                }
            ]
        }
    ]
}