1. 接口描述
接口请求域名: antiddos.tencentcloudapi.com 。
获取业务流量曲线
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:DescribeBizTrend。 |
Version | 是 | String | 公共参数,本接口取值:2020-03-09。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Statistics | 是 | String | 统计方式,可取值max, min, avg, sum, 如统计纬度是流量速率或包量速率,仅可取值max 示例值:max |
Business | 是 | String | DDoS防护子产品代号(bgpip表示高防IP) 示例值:bgp |
Period | 是 | Integer | 统计周期,可取值60,300,1800,3600,21600,86400,单位秒 示例值:1 |
StartTime | 是 | Timestamp | 统计开始时间。 例:“2020-09-22 00:00:00” 示例值:2020-09-22 00:00:00 |
EndTime | 是 | Timestamp | 统计结束时间。 例:“2020-09-22 00:00:00” 示例值:2020-09-22 00:00:00 |
Id | 是 | String | 资源实例ID 示例值:bgp-0000 |
MetricName | 是 | String | 统计纬度,可取值connum, new_conn, inactive_conn, intraffic, outtraffic, inpkg, outpkg, qps 示例值:intraffic |
Domain | 否 | String | 统计纬度为qps时,可选特定域名查询 示例值:test.tencentddos.com |
ProtoInfo.N | 否 | Array of ProtocolPort | 协议及端口列表,协议可取值TCP, UDP, HTTP, HTTPS,仅统计纬度为连接数时有效 |
BusinessType | 否 | String | 业务类型可取值domain, port port:端口业务 domain:域名业务 示例值:domain |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
DataList | Array of Float | 曲线图各个时间点的值 示例值:[1.2,2.2] |
MetricName | String | 统计纬度 示例值:intraffic |
MaxData | Integer | 返回DataList中的最大值 注意:此字段可能返回 null,表示取不到有效值。 示例值:0 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 获取高防IP业务流量曲线
获取高防IP业务流量曲线
输入示例
POST / HTTP/1.1
Host: antiddos.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeBizTrend
<公共请求参数>
{
"Domain": "test.com",
"Statistics": "avg",
"Business": "bgpip",
"ProtoInfo": [
{
"Protocol": "TCP",
"Port": 1
}
],
"Period": 1,
"StartTime": "2020-09-22 00:00:00",
"EndTime": "2020-09-22 00:00:00",
"Id": "bgpip-00000001",
"BusinessType": "domain",
"MetricName": "qps"
}
输出示例
{
"Response": {
"DataList": [
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": "intraffic",
"MaxData": 236,
"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。
- Tencent Cloud SDK 3.0 for Python: GitHub Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
DryRunOperation | DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。 |
FailedOperation | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |
LimitExceeded | 超过配额限制。 |
MissingParameter | 缺少参数错误。 |
ResourceInUse | 资源被占用。 |
ResourceNotFound | 资源不存在。 |
ResourceUnavailable | 资源不可用。 |