Documentation|Tencent Cloud

Recent Pages

Documentation

DescribeDDoSTrend

Last updated: 2020-07-31 10:08:48

1. API Description

Domain name for API request: dayu.tencentcloudapi.com.

This API is used to get the data of DDoS attack traffic bandwidth and attack packet rate.

A maximum of 10 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common parameter. The value used for this API: DescribeDDoSTrend.
Version	Yes	String	Common parameter. The value used for this API: 2018-07-09.
Region	No	String	Common parameter. This parameter is not required for this API.
Business	Yes	String	Anti-DDoS service type. `bgpip`: Anti-DDoS Advanced; `bgp`: Anti-DDoS Pro (Single IP); `bgp-multip`: Anti-DDoS Pro (Multi-IP); `net`: Anti-DDoS Ultimate; `basic`: Anti-DDoS Basic
Ip	Yes	String	Anti-DDoS instance IP
MetricName	Yes	String	Metric. Valid values: [bps (attack traffic bandwidth), pps (attack packet rate)]
Period	Yes	Integer	Statistical granularity. Valid values: [300 (5-minute), 3600 (hourly), 86400 (daily)]
StartTime	Yes	Timestamp	Statistics start time
EndTime	Yes	Timestamp	Statistics end time
Id	No	String	Resource instance ID. If `Business` is `basic`, this field is not required (because Anti-DDoS Basic has no resource instance)

3. Output Parameters

Parameter Name	Type	Description
Business	String	Anti-DDoS service type. `bgpip`: Anti-DDoS Advanced; `bgp`: Anti-DDoS Pro (Single IP); `bgp-multip`: Anti-DDoS Pro (Multi-IP); `net`: Anti-DDoS Ultimate; `basic`: Anti-DDoS Basic
Id	String	Anti-DDoS instance ID Note: this field may return null, indicating that no valid values can be obtained.
Ip	String	Resource IP
MetricName	String	Metric. Valid values: [bps (attack traffic bandwidth), pps (attack packet rate)]
Period	Integer	Statistical granularity. Valid values: [300 (5-minute), 3600 (hourly), 86400 (daily)]
StartTime	Timestamp	Statistics start time
EndTime	Timestamp	Statistics end time
Data	Array of Integer	Value array
Count	Integer	Number of values
RequestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting DDoS attack metric data

Input Example

https://dayu.tencentcloudapi.com/?Action=DescribeDDoSTrend
&Business=bgp
&Id=bgp-00000010
&Ip=3.3.3.3
&MetricName=bps
&StartTime=2018-08-27 15:05:10
&EndTime=2018-08-27 16:05:10
&Period=3600
&<Common request parameters>

Output Example

{
  "Response": {
    "Business": "bgp",
    "Count": 1,
    "Data": [
      1234
    ],
    "EndTime": "2018-08-27 16:05:10",
    "Id": "bgp-00000010",
    "Ip": "3.3.3.3",
    "MetricName": "bps",
    "Period": 3600,
    "RequestId": "eac6b301-a322-493a-8e36-83b295459397",
    "StartTime": "2018-08-27 15:05:10"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.