CDN Pro
获取一段时间内的带宽汇总数据。可以按加速域名或serverGroups(节点组)进行查询和分组。
Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试
参数名称 | 类型 | 必填 | 描述 |
---|---|---|---|
startdate | String | 是 | 查询范围的开始时间,以RFC 3339日期格式表示。必须使用UTC时区指定时间。示例:startdate=2019-10-30T00:00:00Z。 |
enddate | String | 是 | 查询范围的结束时间,以RFC 3339日期格式表示。必须使用UTC时区指定时间。示例:enddate=2019-11-14T00:00:00Z。由于数据处理存在延迟,所指定的结束时间必须至少比当前时间早5分钟,否则返回的数据可能不准确。 |
scheme | String | 否 | [ 0 .. 5 ] 字符 取值范围: http, https, all 默认值: all 指定查询HTTP与/或HTTPS协议的数据。默认查询全部2种协议的数据。 |
参数名称 | 类型 | 必填 | 描述 |
---|---|---|---|
filters | GetASummaryOfTrafficBandwidthRequestFilters | 否 | |
hostnames | List | 否 | 指定加速域名进行查询。可使用泛域名,如*.domain.com。如果未指定,将返回所有加速域名的数据。 |
serverGroups | List | 否 | 指定serverGroups(节点组)进行查询。 |
groupBy | List | 否 | <= 2 条目 指定分组依据对数据进行分组汇总。支持按'hostnames','serverGroups'单独进行分组汇总,也支持同时指定这2个参数进行分组汇总。 |
参数名称 | 类型 | 描述 |
---|---|---|
metaData | GetASummaryOfTrafficBandwidthResponseMetaData | |
startTime | String | RFC 3339格式的日期,表示查询的起始时间。 |
endTime | String | RFC 3339格式的日期,表示查询的结束时间。 |
isComplete | Boolean | 返回最多10000个分组的数据。如果实际组数超过10000,则isComplete将为false。 |
dataNames | List | 表示返回的数据类型。'edge bandwidth'指边缘带宽。 |
dataUnit | String | 表示返回值的计量单位。 |
groups | List | 分组汇总数据。 |
group | String | 分组名称。'__all__' 是一个特殊分组,包含其它所有分组的数据。 |
data | List | 带宽值。 |
错误代码(code) | 描述(message) | HTTP状态码 | 语义 |
---|---|---|---|
InvalidGroupBy | Invalid group name(s): "x". We only support grouping by "hostnames" and "serverGroups" only. | 400 | grouBy参数无效,仅支持 "hostnames"和"serverGroups"。 |
InvalidTimeSpan | The parameter 'enddate' should be after 'startdate'. | 400 | enddate参数的时间必须在startdate时间之后。 |
#!/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/bandwidthSummary?startdate=2021-10-01T12:35:00Z&enddate=2021-11-12T12:40:00Z" \ -X "POST" \ -u "$username:$password" \ -H "Date: $date" \ -H "Accept: application/json" \
{ "metaData": { "startTime": "2021-10-01T12:35:00Z", "endTime": "2021-11-12T12:40:00Z", "isComplete": true, "dataNames": [ "edge bandwidth" ], "dataUnit": "megabits per second" }, "groups": [ { "group": "__all__", "data": [ 76763.00002 ] }, { "group": "hostname1.domain.info", "data": [ 123.00001 ] }, { "group": "hostname2.domain.info", "data": [ 67580.00001 ] }, { "group": "hostname3.domain.info", "data": [ 8720 ] }, { "group": "zi.domain.info", "data": [ 340 ] } ] }