1. 接口描述
接口请求域名: dayu.tencentcloudapi.com 。
获取业务转发统计数据,支持转发流量和转发包速率
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeTransmitStatis |
Version | 是 | String | 公共参数,本接口取值:2018-07-09 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Business | 是 | String | 大禹子产品代号(bgpip表示高防IP;net表示高防IP专业版;shield表示棋牌盾;bgp表示独享包;bgp-multip表示共享包) |
Id | 是 | String | 资源实例ID |
MetricName | 是 | String | 指标名,取值: traffic表示流量带宽; pkg表示包速率; |
Period | 是 | Integer | 统计时间粒度(300表示5分钟;3600表示小时;86400表示天) |
StartTime | 是 | Timestamp | 统计开始时间,秒部分保持为0,分钟部分为5的倍数 |
EndTime | 是 | Timestamp | 统计结束时间,秒部分保持为0,分钟部分为5的倍数 |
IpList.N | 否 | Array of String | 资源的IP(当Business为bgp-multip时必填,且仅支持一个IP);当不填写时,默认统计资源实例的所有IP;资源实例有多个IP(比如高防IP专业版)时,统计方式是求和; |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
InDataList | Array of Float | 当MetricName=traffic时,表示入流量带宽,单位bps; 当MetricName=pkg时,表示入包速率,单位pps; |
OutDataList | Array of Float | 当MetricName=traffic时,表示出流量带宽,单位bps; 当MetricName=pkg时,表示出包速率,单位pps; |
MetricName | String | 指标名: traffic表示流量带宽; pkg表示包速率; |
RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取业务转发统计数据
输入示例
https://dayu.tencentcloudapi.com/?Action=DescribeTransmitStatis
&Business=bgpip
&Id=bgpip-000000x7
&Period=300
&StartTime=2018-08-28 07:15:00
&EndTime=2018-08-28 10:05:00
&MetricName=traffic
&<公共请求参数>
输出示例
{
"Response": {
"InDataList": [
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
],
"OutDataList": [
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
],
"MetricName": "traffic",
"RequestId": "eac6b301-a322-493a-8e36-83b295459397"
}
}
5. 开发者资源
API Explorer
该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
命令行工具
6. 错误码
该接口暂无业务逻辑相关的错误码,其他错误码详见 公共错误码。