接口 GetCdnOriginStat 通过入参 statType 不同可指定查询回源带宽、回源流量、回源请求数、回源失败请求数、回源失败率明细数据,此文档对回源带宽明细查询方式进行了详细说明。
接口描述
本接口可用于查询域名指定时间区间的回源带宽明细数据。
请求域名:cdn.api.qcloud.com
接口:GetCdnOriginStat
注意:
- 可一次提交多个域名(最多20个),查询每一个域名的实时回源带宽明细数据。
- 回源带宽数据5分钟一个统计点,实时数据延迟5 - 10分钟。
- 支持60天内的数据查询,大于等于起始时间,小于等于结束时间。
- 默认情况下,时间区间3天以内数据粒度为5分钟明细;时间区间4 - 7天数据粒度为1小时(峰值带宽),时间区间8天及以上数据粒度为1天(日峰值带宽)。
- 调用频次限制为100次 / 分钟。
- 接口已支持子账号调用,权限配置可参考权限 配置示例。
查看 调用示例。
请求参数
以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,详情请参见 公共请求参数 页面。其中,此接口的 Action 字段为 GetCdnOriginStat。
参数名称 | 是否必选 | 类型 | 描述 |
---|---|---|---|
startTime | 是 | String | 查询起始时间 |
endTime | 是 | String | 查询结束时间 |
hosts.n | 是 | String | 域名 |
statType | 是 | String | 统计类型 "bandwidth":回源带宽 |
detail | 否 | String | 时间粒度 "1":均返回5分钟粒度明细数据 其他:按默认规则返回 |
响应参数
参数名称 | 类型 | 描述 |
---|---|---|
code | Int | 公共错误码,0:成功,其他值:失败。 详情请参见错误码页面 公共错误码 |
message | String | 模块错误信息描述,与接口相关 |
codeDesc | String | 英文错误信息,或业务侧错误码 详情请参见错误码页面 业务错误码 |
data | Array | 结果数据,详细说明见下文 |
详细说明
data
名称 | 类型 | 说明 |
---|---|---|
start_datetime | String | 起始时间 |
end_datetime | String | 结束时间 |
period | String | 时间粒度 |
bandwidth | Array | 回源带宽明细数据,单位:bps |
示例代码
示例参数
startTime:2017-10-28 00:00:00
endTime:2017-10-28 01:05:00
hosts.0:www.test.com
statType:bandwidth
GET 请求
GET 请求需要将所有参数都加在 URL 后:
https://cdn.api.qcloud.com/v2/index.php?
Action=GetCdnOriginStat
&SecretId=XXXXXXXXXXXXXXXXXXXXXXXXXXX
&Timestamp=1462422547
&Nonce=12345678
&Signature=XXXXXXXXXXXXXXXXXXXXXXXXX
&startTime=2017-10-28+00%3A00%3A00
&endTime=2017-10-28+00%3A05%3A00
&hosts.0=www.test.com
&statType=bandwidth
POST 请求
POST 请求时,参数填充在 HTTP Request-body 中,请求地址:
https://cdn.api.qcloud.com/v2/index.php
参数支持 form-data、x-www-form-urlencoded 等格式,参数数组如下:
array (
'Action' => 'GetCdnOriginStat',
'SecretId' => 'XXXXXXXXXXXXXXXXXXXXXXXXXXXX',
'Timestamp' => 1462782282,
'Nonce' => 123456789,
'Signature' => 'XXXXXXXXXXXXXXXXXXXXXXXX',
'startTime' => '2017-10-28 00:00:00',
'endTime' => '2017-10-28 00:05:00',
'hosts.0' => 'www.test.com',
'statType' => 'bandwidth'
)
结果示例
{
"code": 0,
"message": "",
"codeDesc": "Success",
"data": {
"period": 5,
"start_datetime": "2017-10-28 00:00:00",
"end_datetime": "2017-10-28 00:05:00",
"bandwidth": {
"www.test.com": [
1234567,
7605898
]
}
}
}