Documentation | Tencent Cloud

search by keyword

Recent Pages

Documentation

DescribeDDoSCount

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

1. API Description

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

This API is used to get the DDoS attack proportion analysis.

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: DescribeDDoSCount.
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
Id	Yes	String	Anti-DDoS instance ID
Ip	Yes	String	Resource IP
StartTime	Yes	Timestamp	Statistics start time
EndTime	Yes	Timestamp	Statistics end time
MetricName	Yes	String	Metric. Valid values: [traffic (attack protocol traffic in KB), pkg (number of attack protocol packets), classnum (number of attack events)]

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
Id	String	Anti-DDoS instance ID
Ip	String	Resource IP
StartTime	Timestamp	Statistics start time
EndTime	Timestamp	Statistics end time
MetricName	String	Metric. Valid values: [traffic (attack protocol traffic in KB), pkg (number of attack protocol packets), classnum (number of attack events)]
Data	Array of KeyValue	`Key-Value` array. Valid values of `Key`: If `MetricName` is `traffic`: If `key` is `TcpKBSum`, it indicates the traffic of TCP packets in KB. If `key` is `UdpKBSum`, it indicates the traffic of UDP packets in KB. If `key` is `IcmpKBSum`, it indicates the traffic of ICMP packets in KB. If `key` is `OtherKBSum`, it indicates the traffic of other packets in KB. If `MetricName` is `pkg`: If `key` is `TcpPacketSum`, it indicates the number of TCP packets. If `key` is `UdpPacketSum`, it indicates the number of UDP packets. If `key` is `IcmpPacketSum`, it indicates the number of ICMP packets. If `key` is `OtherPacketSum`, it indicates the number of other packets. If `MetricName` is `classnum`: The value of `key` indicates the attack event type. When the `key` is `UNKNOWNFLOOD`, it indicates unknown attack events.
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 counts

Input Example

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

Output Example

{
  "Response": {
    "Business": "bgpip",
    "Data": [],
    "EndTime": "2019-03-07 14:50:00",
    "Id": "bgpip-000000y0",
    "Ip": "3.3.3.3",
    "RequestId": "69b1692b-4b6e-47c0-a7d6-0ff0da286874",
    "StartTime": "2019-03-07 00:00:00"
  }
}

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.