带宽明细查询

最近更新时间:2018-05-29 17:38:36

接口 GetCdnHostsDetailStatistics 通过入参 statType 不同可指定查询带宽、流量、请求数、命中请求数、命中流量、状态码等明细数据,此文档对带宽明细查询方式进行了详细说明

接口描述

GetCdnHostsDetailStatistics 查询指定时间区间的带宽明细数据。

请求域名:cdn.api.qcloud.com

注意事项:

  • 可一次提交多个域名(最多 10 个),查询每一个域名的实时带宽明细数据,及每一个域名累加后的实时带宽明细数据
  • 可一次提交一个或多个项目ID,获取一个项目,或多个项目累加后的实时带宽明细数据
  • 不指定域名或项目可查询账号维度实时带宽明细数据
  • 带宽数据 5 分钟一个统计点,实时数据延迟 5-10 分钟
  • 支持 60 天内的数据查询,大于等于起始时间,小于等于结束时间
  • 默认情况下,时间区间 3 天以内数据粒度为 5 分钟明细;时间区间 4-7 天数据粒度为 1 小时(峰值),时间区间 8 天及以上数据粒度为1天(日峰值)
  • 调用频次限制为 100次/分钟
  • 接口已支持子账号调用,权限配置可参考权限配置示例

查看调用示例

入参说明

以下请求参数列表仅列出了接口请求参数,正式调用时需要加上公共请求参数,见公共请求参数页面。其中,此接口的 Action 字段为 GetCdnHostsDetailStatistics。

参数名称 是否必选 类型 描述
startTime String 查询开始时间
endTime String 查询结束时间
statType String 统计量类型
"bandwidth":表示带宽明细
projects.n Int 项目ID,查看详情
hosts.n String 域名
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
bandwidth_total Array 多域名时,表示总带宽数据,单位为 bps

调用案例

示例参数

startTime:2017-12-02 00:00:00
endTime:2017-12-02 23:55:00
hosts.0www. test.com
statTypebandwidth

GET 请求

GET 请求需要将所有参数都加在 URL 后:

https://cdn.api.qcloud.com/v2/index.php?
Action=GetCdnHostsDetailStatistics
&SecretId=XXXXXXXXXXXXXXXXXXXXXX
&Timestamp=1462416887
&Nonce=123456789
&Signature=XXXXXXXXXXXXXXXXXX
&startTime=2017-12-02+00%3A00%3A00
&endTime=2017-12-02+23%3A55%3A50
&statType=bandwidth
&hosts.0=www.test.com

POST 请求

POST请求时,参数填充在 HTTP Request-body 中,请求地址:

https://cdn.api.qcloud.com/v2/index.php

参数支持 form-data、x-www-form-urlencoded 等格式,参数数组如下:

array (
  'Action' => 'GetCdnHostsDetailStatistics',
  'SecretId' => 'XXXXXXXXXXXXXXXXXXXXXXXXXXXX',
  'Timestamp' => 1462782282,
  'Nonce' => 123456789,
  'Signature' => 'XXXXXXXXXXXXXXXXXXXXXXXX',
  'startTime' => '2017-12-02 00:00:00',
  'endTime' => '2017-12-02 23:55:00',
  'statType' => 'bandwidth',
  'hosts.0' => 'www.test.com'
)

结果示例

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "errmsg": "ok",
    "data": {
        "period": 5,
        "start_datetime": "2016-12-02 00:00:00",
        "end_datetime": "2016-12-02 23:55:00",
        "bandwidth": {
            "www.test.com": [
                12345,
                12345,
                ...
            ]
        },
        "bandwidth_total": [
            12345,
            12345,
            ...
        ]
    }
}