消耗统计查询

最近更新时间:2018-11-08 10:14:03

1. 接口描述

本接口(GetCdnOverseaStat)用于查询指定域名、指定日期的消耗统计信息,包括流量统计明细和带宽统计明细。

  • 每五分钟一个统计点,一天共有 288 个统计点。
  • 指定日期可选区间为 30 天内。
  • 一次可查询账号下所有域名累计的消耗统计信息,或指定查询一个域名的信息(域名需要已经开通境外 CDN)。

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

调用 Demo 实例

2. 输入参数

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

参数名称 是否必选 类型 描述
date String 指定查询日期,格式为:2016-09-22
host String 指定查询一个域名的消耗统计信息

注意:
date:查询日期,暂时仅支持 30 天内数据查询,格式需要为 xxxx-xx-xx。

3. 输出参数

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

data 字段说明

参数名称 类型 描述
period Int 统计数据时间区间,默认为 5 分钟
app_id String 腾讯云 服务账号,与 UIN 对应
host String 指定查询的域名
start_datetime String 查询起始时间点,若填入日期为 2016-09-22,则为 2016-09-22 00:00:00
end_datetime String 查询结束时间点,若填入日期为 2016-09-22,则为 2016-09-22 23:55:00
time_data Object 请求数明细数据,详细说明如下
bandwidth Int 当日峰值带宽,单位为 bps
bandwidth95 Int 当日 95 带宽值,单位为 bps
flux Int 单日流量总累计量,单位为 Byte

time_data 字段说明

参数名称 类型 描述
bandwidth Array 带宽统计量数组
flux Array 流量统计量数组
flux_cache Array 缓存命中率统计量数组

注意:

  • bandwidth 为 Int 类型数组,从指定查询日期 0 点开始,每 5 分钟一个数据,单位为 bps。
  • flux为Int 类型的数组,从指定查询日期 0 点开始,每 5 分钟一个数据,单位为 Byte。
  • flux_cache 为 Float 类型的数组,从指定查询日期 0 点开始,每 5 分钟一个数据。
  • 00:00:00 的统计量代表了 00:00:00 - 00:04:59 期间的统计量。

4. 示例

4.1 输入示例

  • date:2016-09-22
  • host:www.test.com

4.2 GET 请求

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

https://cdn.api.qcloud.com/v2/index.php?
Action=GetCdnOverseaStat
&SecretId=XXXXXXXXXXXXXXXXXXXXXXXXXXX
&Timestamp=1462422547
&Nonce=12345678
&Signature=XXXXXXXXXXXXXXXXXXXXXXXXX
&date=2016-09-22
&host=www.test.com

4.3 POST 请求

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

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

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

array (
  'Action' => 'GetCdnOverseaStat',
  'SecretId' => 'XXXXXXXXXXXXXXXXXXXXXXXXXXXX',
  'Timestamp' => 1462782282,
  'Nonce' => 123456789,
  'Signature' => 'XXXXXXXXXXXXXXXXXXXXXXXX',
  'date' => '2016-09-22',
  "host" => 'www.test.com'
)

4.4 返回结果示例

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": {
        "period": 5,
        "app_id": 1234567
        "host": "www.test.com",
        "start_datetime": "2016-09-22 00:00:00",
        "end_datetime": "2016-09-22 23:55:00",
        "time_data": {
            "bandwidth": [
                1,
                2,
                ...
            ],
            "flux": [
                1,
                2,
                ...
            ]
            "flux_cache": [
                97.332131224188,
                99.612949014396
            ]
        },
      "bandwidth":123456,
      "bandwidth95":123456,
      "flux":123456
    }
}