获取转发报表数据

最近更新时间:2021-02-04 16:23:44

我的收藏

1. 接口描述

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

为大禹子产品提供业务转发指标数据的接口

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeBaradData。
Version String 公共参数,本接口取值:2018-07-09。
Region String 公共参数,本接口不需要传递此参数。
Business String 大禹子产品代号(bgpip表示高防IP;net表示高防IP专业版)
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=bgpip
&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 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

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

命令行工具

6. 错误码

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

目录