Get DDoS Attack Details

Last updated: 2020-06-09 15:24:48


    This is a legacy API which has been hidden and will no longer be updated. We recommend using the new Anti-DDoS Advanced API 3.0 which is standardized and faster.

    API Description

    This API (BGPIPDDoSGetDetails) is used to obtain the details of DDoS attack traffic received by an Anti-DDoS Advanced IP.
    Protocol: HTTPS
    Domain Name:

    Request Parameters

    Below is a list of API request parameters. You need to add common request parameters to your request when calling this API. For more information, see Common Request Parameters. The Action field for this API is NS.BGPIP. Protection.DDoS.GetDetails.

    Parameter Required Type Description
    id Yes String ID of the Anti-DDoS Advanced instance
    beginDate Yes String Start time of queried period. Format: YYYY-MM-DD. Example: 2016-11-10.
    endDate Yes String End time of queried period. Format: YYYY-MM-DD, such as 2016-11-11.
    filtering.overload No String Valid values: yes/no
    yes: only list the data of attack traffic exceeding the peak.
    no: only list the data of traffic not exceeding the peak.
    sorting.field No String Valid value: peak (sort by attack traffic peak).
    sorting.order No String Valid values: asc/desc
    asc: Sort in ascending order
    desc: Sort in a descending order
    paging.index Yes Integer Page index
    0: page 1
    paging.count Yes Integer Number of results returned per page

    Response Parameters

    Parameter Example Type Description
    total 123 Integer Total number of entries
    records [obj,…] Array Details of attacks:
    "startTime" : "2013-03-01 01:23:45",
    "endTime" : "2013-03-01 01:23:45",
    "peak" : 1234
    "overload" : "yes/no"
    startTime 2013-03-01
    Time Start time of the attack
    endTime 2013-03-01
    Time End time of the attack
    peak 80 Gbps Integer Attack traffic peak
    overload yes/no String Whether the attack traffic exceeds the protection bandwidth

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback