全站加速网络
有奖征文：腾讯云大模型知识引擎xDeepSeek > HOT
文档中心>全站加速网络>API 文档>全站加速网络 API 2017>数据查询相关接口>监控数据查询>带宽监控数据查询

带宽监控数据查询

最近更新时间：2019-12-31 14:53:13

我的收藏

本页目录：

接口描述

本接口示例用于指导带宽监控数据查询。 域名：dsa.api.qcloud.com 接口名：GetDsaStatistics
Note:
1. 该接口调用频次上限为100次/分钟，请勿高频调用。
2. 可一次查询多个项目或多个域名的监控明细数据。
3. 支持最长查询时间跨度90天。

请求参数

以下请求参数列表仅列出了接口请求参数，正式调用时需要加上公共请求参数，详情请参见 公共请求参数 页面，此接口的 Action 字段为 GetDsaStatistics。  
参数
必选
类型
示例
描述
metrics
是
String
["bandwidth"]
统计指标，按JSON 格式提交</br>例如：["bandwidth"]
projects
否
Unsigned
[1001853]
项目 ID 列表，查看项目 ID</br>按 JSON 格式提交
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 方式提交请求。
<span ID="lidu"></span>查询时间粒度规则
起止时间跨度
默认粒度
支持查询时间粒度
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. 带宽监控数据每1分钟为一个基本数据采样点。
2. 5分钟粒度的访问带宽，以1分钟粒度带宽为样本点，取5分钟内的平均带宽值。
3. 大于5分钟粒度的访问带宽，以5分钟粒度带宽为样本点，取最大带宽值。

响应参数

参数
类型
描述
code
Int
公共错误码</br>0：表示成功</br>其他值：表示失败</br>详情请参见 错误码 文档中的公共错误码说明
message
String
模块错误信息描述，与接口相关
codeDesc
String
英文错误信息，或业务侧错误码
data
Array或Object
详细查询数据信息，详细请参见 data 字段说明
<span id="data"></span>

data 字段说明

1、按账号维度查询时，data内容是一个数组，每个数组元素包含一个监控点的带宽明细数据，数组字段如下：
参数
类型
描述
datetime
String
数据时间刻度</br>例如：2018-04-19 01:00:00
bandwidth
Unsigned
带宽明细值，单位：bps
2、按项目维度查询时，data内容是一个对象，每个对象元素是一个项目的带宽明细数组，具体信息如下：
参数
类型
描述
项目ID
Array
项目详细带宽监控数据数组，数组字段如下：</br>“datetime”：数据时间刻度</br>“bandwidth”：带宽明细值，单位：bps
3、按域名维度查询时，data内容是一个对象，每个对象元素是一个域名的带宽明细数组，具体信息如下：
参数
类型
描述
域名
Array
域名详细带宽监控数据数组，数组字段如下：</br>“datetime”：数据时间刻度</br>“bandwidth”：带宽明细值，单位：bps

示例一 按账号维度查询

查询需求说明

查询账号下全部域名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=["bandwidth"]
&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' => '["bandwidth"]',
  'startDate' => 2018-04-19,
  'endDate' => 2018-04-19,
  'granularity' => 60
)

返回结果示例

查询成功

{
    "code": 0,
    "message": "",
    "codeDesc": "Success",
    "data": [
        {
            "datetime": "2018-04-19 00:00:00",
            "bandwidth": 589746515
        },
        {
            "datetime": "2018-04-19 01:00:00",
            "bandwidth": 489746515
        },
        {
            "datetime": "2018-04-19 02:00:00",
            "bandwidth": 375489625
        },
         ......
        {
            "datetime": "2018-04-19 23:00:00",
            "bandwidth": 589746515
        }
    ]
}

查询失败

{
    "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=["bandwidth"]
&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' => '["bandwidth"]',
  '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",
                 "bandwidth": 589746515
            }
        ],
        "1006363":[
            {
                "datetime": "2018-04-19 00:00:00",
                 "bandwidth": 264875853
            }
        ]
    }
}

查询失败

{
    "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=["bandwidth"]
&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' => '["bandwidth"]',
  '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",
                "bandwidth": 7634651
            },
            {
                "datetime": "2018-04-19 00:05:00",
                "bandwidth": 6727465
            },
            {
                "datetime": "2018-04-19 00:10:00",
                "bandwidth": 6754896
            },
             ......
            {
                "datetime": "2018-04-19 23:55:00",
                "bandwidth": 8589746
            }
        ]
    }
}

查询失败

{
    "code": 4100,
    "message": "鉴权失败，请参考文档中鉴权部分。",
    "codeDesc": "AuthFailure"
}
中国站
文档活动
message-icon联系我们
目录