域名统计指标查询

最近更新时间:2018-12-25 11:49:56

接口描述

本接口用于查询指定时间段内的域名访问统计指标,您可以利用此接口查询域名的访问情况。
域名:dsa.api.qcloud.com
接口名:GetDsaHostStatistics

注意:

  1. 该接口调用频次上限为100次/分钟,请勿高频调用。
  2. 可一次查询多个项目或多个域名,分域名展示汇总用量数据。

统计指标说明

统计指标 指标名称 指标说明
总流量 flux 按域名维度统计查询时间段内的流量总和,单位:Byte
峰值带宽 bandwidth 按域名维度统计查询时间段内的峰值带宽,单位:bps
总请求次数 request 按域名维度统计查询时间段内的请求次数总和,单位:次数
平均访问延时 delay 按域名维度统计查询时间段内的平均访问延时,单位:ms

请求参数

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

参数 必选 类型 示例 描述
metrics String flux 统计指标名称,详情请参见 统计指标说明
projects Unsigned [1001853] 项目ID列表,查看项目ID
按 JSON 格式提交
hosts String test.qcloud.com 域名列表,当根据域名查询数据时使用
按 JSON 格式提交域名名称
startDate String 2018-04-19 开始时间
格式:YY-MM-DD
endDate String 2018-04-20 结束时间
格式:YY-MM-DD
offset Unsigned 15 查询偏移个数
length Unsigned 10 本次查询长度

参数说明:

  • 开始时间或结束时间为空时,默认返回查询当日统计数据。
  • 未指定查询目标时,默认按照账号维度查询全部域名的合并统计数据。
  • 当查询多个项目或多个域名时,为了防止查询参数过长导致 URL 越界,建议采用 POST 方式提交请求。
  • 当账号下域名较多时,您可以通过 offset 和 length 参数设置分段查询,查询域名按照 metrics 指定的第一个指标倒序排列。

响应参数

参数 类型 描述
code Int 公共错误码
0:表示成功
其他值:表示失败
详情请参见 错误码说明 页面中的公共错误码说明
message String 模块错误信息描述,与接口相关
codeDesc String 英文错误信息,或业务侧错误码
data Array 详细查询数据信息,详细请参见 data 字段说明

data 字段说明

参数名称 类型 描述
host String 域名名称
例如:dsatest.qcloud.com
flux Unsigned 总流量值
bandwidth Unsigned 峰值带宽值
request Unsigned 总请求次数
delay Unsigned 平均访问时延

代码示例

配置需求示例

查询账号下全部域名2018-04-17的流量、带宽和请求次数统计数据。

GET 请求

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

https://dsa.api.qcloud.com/v2/index.php?
Action=GetDsaHostStatistics
&SecretId=XXXXXXXXXXXXXXXXXXXXXXXXXXX
&Timestamp=1524279600
&Nonce=123456789
&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX
&metrics=[bandwidth]
&startDate=2018-04-17
&endDate=2018-04-17

注意:

为了防止查询参数过长,导致 URL 越界,该接口默认采用 POST 方式提交查询请求。

POST 请求

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

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

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

array (
  'Action' => 'GetDsaStatistics',
  'SecretId' => 'SecretId',
  'Timestamp' => 1524279600,
  'Nonce' => 123456789,
  'Signature' => 'Signature',
  'metrics' => '["flux","bandwidth","request"]',
  'startDate' => "2018-04-17"
  'endData' => "2018-04-17"
)

返回结果示例

查询成功

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": [{
            "host": "a.dsa.qcloud.com",
            "flux": 265412354,
            "bandwidth": 589746515,
            "request": 123456548
        },
        ......
        {
            "host": "b.dsa.qcloud.com",
            "flux": 362124545,
            "bandwidth": 749516585,
            "request": 156534248
        }
    ]
}

查询失败

{
    "code": 4100,
    "message": "鉴权失败,请参考文档中鉴权部分。",
    "codeDesc": "AuthFailure"
}