查询流量汇总信息

更新时间:2023-03-28 17:33:31

适用产品

CDN Pro

接口描述

获取一段时间内的边缘、中间层(CDN Pro服务器之间)和回源流量的汇总数据。可以在请求体中指定加速域名或serverGroups(节点组)等参数进行查询和分组。

调用频率

单用户调用频率:300/5min

推荐使用 Open API在线调试

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

请求参数

Params 参数

参数名称描述
*startdateString
查询范围的开始时间,以RFC 3339日期格式表示。必须使用UTC时区指定时间。示例:startdate=2019-10-30T00:00:00Z。
*enddateString
查询范围的结束时间,以RFC 3339日期格式表示。必须使用UTC时区指定时间。示例:enddate=2019-11-14T00:00:00Z。由于数据处理存在延迟,所指定的结束时间必须至少比当前时间早5分钟,否则返回的数据可能不准确。
schemeString
取值范围: http,https 指定协议进行查询。

Body 参数

参数名称描述
filtersObject
指定查询条件过滤报表数据。
hostnamesList
指定加速域名进行查询。可使用泛域名,如*.domain.com。如果未指定,将返回所有加速域名的数据。
serverGroupsList
指定serverGroups(节点组)进行查询。
propertyIdsList
指定加速项目ID进行查询。
propertyHostnamesList
指定加速域名进行查询。上述hostnames参数将匹配用户请求时访问的hostnames进行查询,而此处的propertyHostnames将匹配加速项目中定义的hostnames进行查询。当加速项目中定义的域名包含泛域名,可使用propertyHostnames参数进行查询。
groupByList
取值范围: <= 2 条目 指定分组依据对数据进行分组汇总。支持按'hostnames','serverGroups'单独进行分组汇总,也支持同时指定这2个参数进行分组汇总。

返回参数

Body 参数

参数名称描述
metaDataObject
此对象包含的字段是对groups对象中返回数据的描述。
startTimeString
RFC 3339格式的日期,表示查询的起始时间。
endTimeString
RFC 3339格式的日期,表示查询的结束时间。
isCompleteBoolean
该接口最多返回10000个分组的数据。如果实际分组数量大于10000,则isComplete值为false。
dataNamesList
返回的数据类型。
数据名称描述
edge response边缘服务器的响应流量
edge request从访客到边缘服务器的请求流量
intermediate responseCDN Pro中间层服务器的响应流量
intermediate request发往CDN Pro中间层服务器的请求流量
origin response源站的响应流量
origin request回源的请求流量
fast route response快速回源产生的响应流量
fast route request快速回源产生的请求流量
dataNames数组中条目的顺序与groups[].data数组返回值的顺序一一对应。
dataUnitString
指示返回值的计量单位。
groupsList
按分组汇总的流量数据。
groupString
分组名称。'__all__' 是一个特殊分组,包括其它所有分组的数据。
dataList
流量值。

错误码

错误代码(code)描述(message)HTTP状态码语义
InvalidGroupByInvalid group name(s): 'hostnames2'. We only support grouping by "hostnames" and "serverGroups".400groupBy参数无效。仅支持按"hostnames","serverGroups"进行分组汇总查询。
InvalidTimeSpanThe parameter 'enddate' should be after 'startdate'.400enddate参数指定的时间必须晚于startdate。

示例

200
400
200
请求示例
复制代码 复制成功
#!/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/cdn/report/volSummary?startdate=2023-01-01T00:00:00Z&enddate=2023-01-02T00:00:00Z" \
-X "POST" \
-u "$username:$password" \
-H "Date: $date" \
-H "Accept: application/json" \
-d '{"filters": {}, "groupBy": ["hostnames"]}'
返回示例
复制代码 复制成功
{
    "metaData": {
        "startTime": "2022-01-29T12:35:00Z",
        "endTime": "2022-02-02T12:40:00Z",
        "isComplete": true,
        "dataNames": [
            "edge response",
            "edge request",
            "intermediate response",
            "intermediate request",
            "origin response",
            "origin request",
            "fast route response",
            "fast route request"
        ],
        "dataUnit": "megabytes"
    },
    "groups": [
        {
            "group": "__all__",
            "data": [
                214.57945,
                12,
                50.9876,
                4,
                13.56,
                5,
                0,
                0
            ]
        }
    ]
}
本篇文档内容对您是否有帮助?
有帮助
我要反馈
提交成功!非常感谢您的反馈,我们会继续努力做到更好!