接口描述
本接口示例用于指导流量监控数据查询。
域名:
dsa.api.qcloud.com
接口名:GetDsaStatistics
Note:
1. 该接口调用频次上限为100次/分钟,请勿高频调用。
2. 可一次查询多个项目或多个域名的实时合并统计数据。
3. 每1分钟为一个统计点,流量数据按照流量值累加统计。
4. 最多支持查询最近60天的数据。
输入参数
参数 | 必选 | 类型 | 示例 | 描述 |
metrics | 是 | String | ["flux"] | 统计指标</br>按 JSON 格式提交 |
projects | 否 | Unsigned | [1001853] | |
hosts | 否 | String | test.qcloud.com | 域名列表</br>按 JSON 格式提交 |
startDate | 否 | String | 2018-04-19 | 开始时间,默认为查询当日日期</br>格式:YY-MM-DD |
endDate | 否 | String | 2018-04-20 | 结束时间,默认为查询当日日期</br>格式:YY-MM-DD |
granularity | 否 | Unsigned | 15 | 查询时间粒度(分钟),详情请参见 查询时间粒度规则 |
Note:
1. 未指定查询目标时,默认按账号维度汇总流量数据。
2. 当指定查询项目列表时,按项目维度汇总流量数据。
3. 当指定查询域名列表时,按域名维度汇总流量数据。
4. 域名列表优先级高于项目列表,当同时指定查询项目列表和域名列表时,按指定的域名列表响应。
5. 当查询多个项目或多个域名时,为了防止查询参数过长导致 URL 越界,建议采用 POST 方式提交请求。
查询时间粒度规则
起止时间跨度 | 默认粒度 | 支持查询时间粒度 |
1 天 | 1 | 1,5,15,30,60,120,240,1440 |
2 ~ 3 天 | 15 | 15,30,60,120,240,1440 |
4 ~ 7 天 | 30 | 30,60,120,240,1440 |
8 ~ 90 天 | 60 | 60,120,240,1440 |
Note:
流量数据每 1 分钟为一个样本点,按照流量值累加统计。
响应参数
data 字段说明
1、按账号维度查询时,data 内容是一个数组,每个数组元素包含一个监控点的流量明细数据,数组字段如下:
参数 | 类型 | 描述 |
datetime | String | 数据时间刻度 例如:2018-04-19 01:00:00 |
flux | Unsigned | 流量明细值,单位:byte |
2、按项目维度查询时,data 内容是一个对象,每个对象元素是一个项目的流量明细数组,具体信息如下:
参数 | 类型 | 描述 |
项目ID | Array | 项目详细流量监控数据数组,数组字段如下: “datetime”:数据时间刻度 “flux”:流量明细值,单位:byte |
3、按域名维度查询时,data 内容是一个对象,每个对象元素是一个域名的流量明细数组,具体信息如下:
参数 | 类型 | 描述 |
域名 | Array | 域名详细流量监控数据数组,数组字段如下: “datetime”:数据时间刻度 “flux”:流量明细值,单位:byte |
示例一 按账号维度查询
查询需求说明
查询账号下全部域名在2018-04-19的流量监控数据,查询时间粒度60分钟。
GET 请求
GET 请求需要将所有参数都加在 URL 后:
https://dsa.api.qcloud.com/v2/index.php?Action=GetDsaStatistics&SecretId=XXXXXXXXXXXXXXXXXXXXXXXXXXX&Timestamp=1524279600&Nonce=123456789&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX&metrics=["flux"]&startDate=2018-04-19&endDate=2018-04-19&granularity=60
POST 请求示例
POST 请求时,参数填充在 HTTP Request-body 中,请求地址:
https://dsa.api.qcloud.com/v2/index.php
参数支持 form-data、x-www-form-urlencoded 等格式,参数数组如下:
array ('Action' => 'GetDsaHostLogs','SecretId' => 'SecretId','Timestamp' => 1524279600,'Nonce' => 123456789,'Signature' => 'Signature','metrics' => '["flux"]','startDate' => 2018-04-19,'endDate' => 2018-04-19,'granularity' => 60)
返回结果示例
查询成功
{"code": 0,"message": "","codeDesc": "Success","data": [{"datetime": "2018-04-19 00:00:00","flux": 874271534},{"datetime": "2018-04-19 01:00:00","flux": 744647032},{"datetime": "2018-04-19 02:00:00","flux": 648965244},......{"datetime": "2018-04-19 23:00:00","flux": 974651168}]}
查询失败
{"code": 4100,"message": "鉴权失败,请参考文档中鉴权部分。","codeDesc": "AuthFailure"}
示例二 按项目维度查询
查询需求说明
同时查询两个项目在2018-04-19的总使用流量,项目ID分别为100873和1006363。
GET 请求
GET 请求需要将所有参数都加在 URL 后:
https://dsa.api.qcloud.com/v2/index.php?Action=GetDsaStatistics&SecretId=XXXXXXXXXXXXXXXXXXXXXXXXXXX&Timestamp=1524279600&Nonce=123456789&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX&metrics=["flux"]&projects=[100873,1006363]&startDate=2018-04-19&endDate=2018-04-19&granularity=1440
POST 请求示例
POST 请求时,参数填充在 HTTP Request-body 中,请求地址:
https://dsa.api.qcloud.com/v2/index.php
参数支持 form-data、x-www-form-urlencoded 等格式,参数数组如下:
array ('Action' => 'GetDsaHostLogs','SecretId' => 'SecretId','Timestamp' => 1524279600,'Nonce' => 123456789,'Signature' => 'Signature','metrics' => '["flux"]','projects' => '[100873,1006363]','startDate' => 2018-04-19,'endDate' => 2018-04-19,'granularity' => 1440)
返回结果示例
查询成功
{"code": 0,"message": "","codeDesc": "Success","data": {"100873":[{"datetime": "2018-04-19 00:00:00","flux": 532316465152}],"1006363":[{"datetime": "2018-04-19 00:00:00","flux": 602812385588}]}}
查询失败
{"code": 4100,"message": "鉴权失败,请参考文档中鉴权部分。","codeDesc": "AuthFailure"}
示例三 按域名维度查询
查询需求说明
查询域名
dsa.test.qcloud.com
在2018-04-19的流量监控数据,查询时间粒度5分钟。GET 请求
GET 请求需要将所有参数都加在 URL 后:
https://dsa.api.qcloud.com/v2/index.php?Action=GetDsaStatistics&SecretId=XXXXXXXXXXXXXXXXXXXXXXXXXXX&Timestamp=1524279600&Nonce=123456789&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXX&metrics=["flux"]&hosts=["dsa.test.qcloud.com"]&startDate=2018-04-19&endDate=2018-04-19&granularity=5
POST 请求示例
POST 请求时,参数填充在 HTTP Request-body 中,请求地址:
https://dsa.api.qcloud.com/v2/index.php
参数支持 form-data、x-www-form-urlencoded 等格式,参数数组如下:
array ('Action' => 'GetDsaHostLogs','SecretId' => 'SecretId','Timestamp' => 1524279600,'Nonce' => 123456789,'Signature' => 'Signature','metrics' => '["flux"]','hosts' => '["dsa.test.qcloud.com"]','startDate' => 2018-04-19,'endDate' => 2018-04-19,'granularity' => 5)
返回结果示例
查询成功
{"code": 0,"message": "","codeDesc": "Success","data": {"dsa.test.qcloud.com":[{"datetime": "2018-04-19 00:00:00","flux": 74634551},{"datetime": "2018-04-19 00:05:00","flux": 69727465},{"datetime": "2018-04-19 00:10:00","flux": 67541896},......{"datetime": "2018-04-19 23:55:00","flux": 80589746}]}}
查询失败
{"code": 4100,"message": "鉴权失败,请参考文档中鉴权部分。","codeDesc": "AuthFailure"}