峰值带宽查询

最近更新时间:2018-05-09 17:26:35

接口 DescribeCdnHostInfo 通过入参 statType 不同可指定查询峰值带宽、总流量、总请求数、平均请求数命中率数据,此文档对峰值带宽查询方式进行了详细说明

接口描述

DescribeCdnHostInfo 可用于查询域名在某一时间区间的峰值带宽数据。

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

注意事项:

  • 可一次提交多个域名、项目,查询各域名、项目下每一个域名的峰值带宽
  • 带宽数据 5 分钟为一个统计点,峰值带宽为指定时间区间中统计点最大值
  • 起始时间精确至日,起始时间设置为 2017-11-29,实际查询起始时间点为 2017-11-29 00:00:00,若结束时间设置为 2017-11-29,实际查询结束时间点为 2017-11-29 23:55:00
  • 若查询域名的峰值带宽,需要传入对应的 projectId
  • 支持 90 天内的数据查询
  • 调用频次限制为 100次/分钟
  • 接口已支持子账号调用,权限配置可参考权限配置示例

查看调用示例

入参说明

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

参数名称 是否必选 类型 描述
startDate String 查询开始日期(日),如 2016-05-03
endDate String 查询结束日期(日),如 2016-05-04
statType String 统计量类型
"bandwidth":表示峰值带宽
projects.n String 项目 ID,查看项目ID
hosts.n String 域名列表

详细说明

参数示例

hosts.0=www.test1.com&hosts.1=www.test2.com

出参说明

参数名称 类型 描述
code Int 公共错误码,0表示成功,其他值表示失败。
详见错误码页面公共错误码
message String 模块错误信息描述,与接口相关。
codeDesc String 英文错误信息,或业务侧错误码。
详见错误码页面业务错误码
data Array 结果数据,详细说明见下文

详细说明

data

参数名称 类型 描述
start_datetime String 起始时间(日)
end_datetime String 结束时间(日)
period Int 数据采样时间间隔,单位为分钟
detail_data Array 汇总数据信息,详细说明见下文

detail_data

参数名称 类型 描述
host_name String 域名
host_type String 域名类型
"cname":自有源接入域名
"cos":COS源接入域名
host_value Int 峰值带宽,单位为 bps

调用案例

示例参数

startDate:20160503
endDate:20160504
projects.0:0
statTypebandwidth

GET 请求

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

https://cdn.api.qcloud.com/v2/index.php?
Action=DescribeCdnHostInfo
&SecretId=XXXXXXXXXXXXXXXXXXXXXXXXXXX
&Timestamp=1462781898
&Nonce=123456789
&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXX
&startDate=20160503
&endDate=20160504
&statType=bandwidth
&projects.0=0

POST 请求

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

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

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

array (
  'Action' => 'DescribeCdnHostInfo',
  'SecretId' => 'XXXXXXXXXXXXXXXXXXXXXXXXXXXX',
  'Timestamp' => 1462782282,
  'Nonce' => 123456789,
  'Signature' => 'XXXXXXXXXXXXXXXXXXXXXXXX',
  'startDate' => '20160503',
  'endDate' => '20160504',
  'statType' => 'bandwidth',
  'projects.0' => '0'
)

结果示例

{
    "retcode": 0,
    "errmsg": "ok",
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": {
        "start_datetime": "2016-05-03 00:00:00",
        "end_datetime": "2016-05-04 23:55:00",
        "period": 5,
        "stat_type": "bandwidth",
        "detail_data": [
            {
                "host_id": "www.test.com",
                "host_name": "www.test.com",
                "host_type": "cname",
                "host_value": 123456789
            },
            ...
        ]
    }
}