文档中心 BGP 高防包 API 文档 统计报表相关接口 获取转发报表数据

获取转发报表数据

最近更新时间：2019-12-05 16:31:57

查看pdf

在这篇文章中：

1. 接口描述

接口请求域名： dayu.tencentcloudapi.com 。

为大禹子产品提供从巴拉多获取指标统计数据的接口

默认接口请求频率限制：20次/秒。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeBaradData
Version 是 String 公共参数，本接口取值：2018-07-09
Region 否 String 公共参数，本接口不需要传递此参数。
Business 是 String 大禹子产品代号（bgpip表示高防IP；net表示高防IP专业版；shield表示棋牌盾）
Id 是 String 资源实例ID
MetricName 是 String 指标名，取值：
connum表示TCP活跃连接数；
new_conn表示新建TCP连接数；
inactive_conn表示非活跃连接数;
intraffic表示入流量；
outtraffic表示出流量；
alltraffic表示出流量和入流量之和；
inpkg表示入包速率；
outpkg表示出包速率；
Period 是 Integer 统计时间粒度，单位秒（300表示5分钟；3600表示小时；86400表示天）
StartTime 是 Timestamp 统计开始时间，秒部分保持为0，分钟部分为5的倍数
EndTime 是 Timestamp 统计结束时间，秒部分保持为0，分钟部分为5的倍数
Statistics 是 String 统计方式，取值：
max表示最大值；
min表示最小值；
avg表示均值；
ProtocolPort.N 否 Array of ProtocolPort 协议端口数组
Ip 否 String 资源实例下的IP，只有当Business=net(高防IP专业版)时才必须填写资源的一个IP（因为高防IP专业版资源实例有多个IP，才需要指定）；

3. 输出参数

参数名称 类型 描述
DataList Array of BaradData 返回指标的值
RequestId String 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取转发报表数据

输入示例

https://dayu.tencentcloudapi.com/?Action=DescribeBaradData
&Business=shield
&Id=bgpip-000000x7
&Period=300
&StartTime=2018-08-28 07:15:00
&EndTime=2018-08-28 10:05:00
&Statistics=max
&MetricName=connum
&ProtocolPort.0.Protocol=tcp
&ProtocolPort.0.Port=80
&<公共请求参数>

输出示例

{
  "Response": {
    "DataList": [
      {
        "MetricName": "connum",
        "Data": [
          236,
          236,
          236,
          236,
          236,
          236,
          236,
          236,
          236,
          236,
          236,
          236,
          236,
          236,
          236,
          236,
          236,
          236,
          236,
          236,
          236,
          236,
          236,
          236,
          236,
          236,
          236,
          236,
          236,
          236,
          236,
          236,
          236,
          236,
          236
        ],
        "Count": 35
      },
      {
        "MetricName": "new_conn",
        "Data": [
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0,
          0
        ],
        "Count": 35
      }
    ],
    "RequestId": "eac6b301-a322-493a-8e36-83b295459397"
  }
}

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力，能显著降低使用云 API 的难度，推荐使用。

SDK

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

命令行工具

6. 错误码

该接口暂无业务逻辑相关的错误码，其他错误码详见 公共错误码。

BGP 高防包 相关文档