From 6c7c1c9d996f6fbfba533916a558febc94fe3e22 Mon Sep 17 00:00:00 2001 From: "Li, Qiao" Date: Wed, 6 Nov 2024 12:22:01 +0000 Subject: [PATCH] AntiDDoS API 20240914 version Reviewed-by: Belejkanic, Lukas Co-authored-by: Li, Qiao Co-committed-by: Li, Qiao --- docs/antiddos/api-ref/antiddos_02_0002.html | 26 ++--- docs/antiddos/api-ref/antiddos_02_0007.html | 24 ++-- docs/antiddos/api-ref/antiddos_02_0017.html | 120 ++++++++------------ docs/antiddos/api-ref/antiddos_02_0020.html | 48 +++----- docs/antiddos/api-ref/antiddos_02_0023.html | 68 +++++++---- docs/antiddos/api-ref/antiddos_02_0024.html | 16 +-- docs/antiddos/api-ref/antiddos_02_0025.html | 64 ++++------- docs/antiddos/api-ref/antiddos_02_0026.html | 56 ++++----- docs/antiddos/api-ref/antiddos_02_0027.html | 74 +++++------- docs/antiddos/api-ref/antiddos_02_0034.html | 9 +- docs/antiddos/api-ref/antiddos_02_0037.html | 50 ++++---- 11 files changed, 230 insertions(+), 325 deletions(-) diff --git a/docs/antiddos/api-ref/antiddos_02_0002.html b/docs/antiddos/api-ref/antiddos_02_0002.html index bafd1be1..62a9fa78 100644 --- a/docs/antiddos/api-ref/antiddos_02_0002.html +++ b/docs/antiddos/api-ref/antiddos_02_0002.html @@ -9,7 +9,7 @@

Request

Request parameters

None

-

Response

  • Parameter description +

    Response Messages

    • Parameter description

      Name

      Type

      @@ -75,32 +75,26 @@
      • Data structure description of links -

        Parameter

        +
        - - - - - - - - - - - diff --git a/docs/antiddos/api-ref/antiddos_02_0007.html b/docs/antiddos/api-ref/antiddos_02_0007.html index 0ff130d5..47f2f9f2 100644 --- a/docs/antiddos/api-ref/antiddos_02_0007.html +++ b/docs/antiddos/api-ref/antiddos_02_0007.html @@ -75,32 +75,26 @@
        • Data structure description of links -

        Parameter

        Mandatory

        +

        Type

        Type

        -

        Description

        +

        Description

        href

        +

        href

        Yes

        +

        String

        String

        -

        URLs of APIs

        +

        URLs of APIs

        rel

        +

        rel

        Yes

        +

        String

        String

        -

        self

        +

        self

        Parameter

        +
        - - - - - - - - - - - diff --git a/docs/antiddos/api-ref/antiddos_02_0017.html b/docs/antiddos/api-ref/antiddos_02_0017.html index 44cb46d1..0af61599 100644 --- a/docs/antiddos/api-ref/antiddos_02_0017.html +++ b/docs/antiddos/api-ref/antiddos_02_0017.html @@ -33,41 +33,33 @@

        None

        Response

        • Parameter description -

        Parameter

        Mandatory

        +

        Type

        Type

        -

        Description

        +

        Description

        href

        +

        href

        Yes

        +

        String

        String

        -

        URL of the API

        +

        URL of the API

        rel

        +

        rel

        Yes

        +

        String

        String

        -

        self

        +

        self

        Parameter

        +
        - - - - - - - - - - - - - - - @@ -75,41 +67,33 @@
        • Data structure description of traffic_limited_list -

        Parameter

        Mandatory

        +

        Type

        Type

        -

        Description

        +

        Description

        traffic_limited_list

        +

        traffic_limited_list

        Yes

        +

        List data structure

        List data structure

        -

        List of traffic limits

        +

        List of traffic limits

        http_limited_list

        +

        http_limited_list

        Yes

        +

        List data structure

        List data structure

        -

        List of HTTP limits

        +

        List of HTTP limits

        connection_limited_list

        +

        connection_limited_list

        Yes

        +

        List data structure

        List data structure

        -

        List of limits of numbers of connections

        +

        List of limits of numbers of connections

        Parameter

        +
        - - - - - - - - - - - - - - - @@ -117,32 +101,26 @@
        • Data structure description of http_limited_list -

        Parameter

        Mandatory

        +

        Type

        Type

        -

        Description

        +

        Description

        traffic_pos_id

        +

        traffic_pos_id

        Yes

        +

        Integer

        Integer

        -

        Position ID of traffic

        +

        Position ID of traffic

        traffic_per_second

        +

        traffic_per_second

        Yes

        +

        Integer

        Integer

        -

        Threshold of traffic per second (Mbit/s)

        +

        Threshold of traffic per second (Mbit/s)

        packet_per_second

        +

        packet_per_second

        Yes

        +

        Integer

        Integer

        -

        Threshold of number of packets per second

        +

        Threshold of number of packets per second

        Parameter

        +
        - - - - - - - - - - - @@ -150,41 +128,33 @@
        • Data structure description of connection_limited_list -

        Parameter

        Mandatory

        +

        Type

        Type

        -

        Description

        +

        Description

        http_request_pos_id

        +

        http_request_pos_id

        Yes

        +

        Integer

        Integer

        -

        Position ID of number of HTTP requests

        +

        Position ID of number of HTTP requests

        http_packet_per_second

        +

        http_packet_per_second

        Yes

        +

        Integer

        Integer

        -

        Threshold of number of HTTP requests per second

        +

        Threshold of number of HTTP requests per second

        Parameter

        +
        - - - - - - - - - - - - - - - diff --git a/docs/antiddos/api-ref/antiddos_02_0020.html b/docs/antiddos/api-ref/antiddos_02_0020.html index c87a73f1..b8dae5aa 100644 --- a/docs/antiddos/api-ref/antiddos_02_0020.html +++ b/docs/antiddos/api-ref/antiddos_02_0020.html @@ -42,59 +42,47 @@

        None

        Response

        -

        Parameter

        Mandatory

        +

        Type

        Type

        -

        Description

        +

        Description

        cleaning_access_pos_id

        +

        cleaning_access_pos_id

        Yes

        +

        Integer

        Integer

        -

        Position ID of access limit during cleaning

        +

        Position ID of access limit during cleaning

        new_connection_limited

        +

        new_connection_limited

        Yes

        +

        Integer

        Integer

        -

        Number of new connections of a source IP address

        +

        Number of new connections of a source IP address

        total_connection_limited

        +

        total_connection_limited

        Yes

        +

        Integer

        Integer

        -

        Total number of connections of a source IP address

        +

        Total number of connections of a source IP address
        Table 1 Parameter description

        Parameter

        +
        - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/antiddos/api-ref/antiddos_02_0023.html b/docs/antiddos/api-ref/antiddos_02_0023.html index 22d93409..27a137be 100644 --- a/docs/antiddos/api-ref/antiddos_02_0023.html +++ b/docs/antiddos/api-ref/antiddos_02_0023.html @@ -113,54 +113,72 @@
        • Data structure description of ddosStatus -
        Table 1 Parameter description

        Parameter

        Mandatory

        +

        Type

        Type

        -

        Description

        +

        Description

        enable_L7

        +

        enable_L7

        Yes

        +

        Boolean

        Boolean

        -

        Whether L7 defense has been enabled.

        +

        Whether L7 defense has been enabled.

        traffic_pos_id

        +

        traffic_pos_id

        Yes

        +

        Integer

        Integer

        -

        Position ID of traffic. The value ranges from 1 to 9, or 99, or 33 to 36.

        +

        Position ID of traffic. The value ranges from 1 to 9, or 99, or 33 to 36.

        http_request_pos_id

        +

        http_request_pos_id

        Yes

        +

        Integer

        Integer

        -

        Position ID of number of HTTP requests. The value ranges from 1 to 15 and 33 to 36.

        +

        Position ID of number of HTTP requests. The value ranges from 1 to 15 and 33 to 36.

        cleaning_access_pos_id

        +

        cleaning_access_pos_id

        Yes

        +

        Integer

        Integer

        -

        Position ID of access limit during cleaning. The value ranges from 1 to 8, or 99, or 33 to 36.

        +

        Position ID of access limit during cleaning. The value ranges from 1 to 8, or 99, or 33 to 36.

        app_type_id

        +

        app_type_id

        Yes

        +

        Integer

        Integer

        -
        Application type ID. Possible values:
        • 0
        • 1
        +
        Application type ID. Possible values:
        • 0
        • 1

        Parameter

        +
        - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + +

        Parameter

        Mandatory

        +

        Type

        Type

        -

        Description

        +

        Description

        floating_ip_address

        +

        floating_ip_address

        Yes

        +

        String

        String

        -

        Floating IP address

        +

        Floating IP address

        floating_ip_id

        +

        floating_ip_id

        Yes

        +

        String

        String

        -

        ID of an EIP

        +

        ID of an EIP

        network_type

        +

        network_type

        Yes

        +

        String

        String

        -

        EIP type. The value can be:

        +

        EIP type. The value can be:

        • EIP: EIP that is bound or not bound with ECS.
        • ELB: EIP that is bound with ELB.

        status

        +

        status

        Yes

        +

        String

        String

        -
        Defense status, the possible value of which is one of the following:
        • normal: indicates that the defense status is normal.
        • configuring: indicates that defense is being configured.
        • notConfig: indicates that defense is not configured.
        • packetcleaning: indicates that traffic cleaning is underway.
        • packetdropping: indicates that traffic is discarded.
        +
        Defense status, the possible value of which is one of the following:
        • normal: indicates that the defense status is normal.
        • configuring: indicates that defense is being configured.
        • notConfig: indicates that defense is not configured.
        • packetcleaning: indicates that traffic cleaning is underway.
        • packetdropping: indicates that traffic is discarded.

        blackhole_endtime

        +

        Long

        +

        End time of a black hole

        +

        protect_type

        +

        String

        +

        Protection type

        +

        traffic_threshold

        +

        Long

        +

        Traffic threshold

        +

        http_threshold

        +

        Long

        +

        HTTP traffic threshold

        +
        diff --git a/docs/antiddos/api-ref/antiddos_02_0024.html b/docs/antiddos/api-ref/antiddos_02_0024.html index 9bc9df3e..d480fcfd 100644 --- a/docs/antiddos/api-ref/antiddos_02_0024.html +++ b/docs/antiddos/api-ref/antiddos_02_0024.html @@ -42,23 +42,19 @@

        None

        Response

        • Parameter description -

          Parameter

          +
          - - - - - - - diff --git a/docs/antiddos/api-ref/antiddos_02_0025.html b/docs/antiddos/api-ref/antiddos_02_0025.html index 1cda0480..2a01a26b 100644 --- a/docs/antiddos/api-ref/antiddos_02_0025.html +++ b/docs/antiddos/api-ref/antiddos_02_0025.html @@ -62,77 +62,61 @@
          • Data structure description of data -

          Parameter

          Mandatory

          +

          Type

          Type

          -

          Description

          +

          Description

          status

          +

          status

          Yes

          +

          String

          String

          -
          Defense status, the possible value of which is one of the following:
          • normal: indicates that the defense status is normal.
          • configuring: indicates that defense is being configured.
          • notConfig: indicates that defense is not configured.
          • packetcleaning: indicates that traffic cleaning is underway.
          • packetdropping: indicates that traffic is discarded.
          +
          Defense status, the possible value of which is one of the following:
          • normal: indicates that the defense status is normal.
          • configuring: indicates that defense is being configured.
          • notConfig: indicates that defense is not configured.
          • packetcleaning: indicates that traffic cleaning is underway.
          • packetdropping: indicates that traffic is discarded.

          Parameter

          +
          - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/antiddos/api-ref/antiddos_02_0026.html b/docs/antiddos/api-ref/antiddos_02_0026.html index f47f049e..0e825e20 100644 --- a/docs/antiddos/api-ref/antiddos_02_0026.html +++ b/docs/antiddos/api-ref/antiddos_02_0026.html @@ -114,69 +114,55 @@
          • Data structure description of logs -

          Parameter

          Mandatory

          +

          Type

          Type

          -

          Description

          +

          Description

          period_start

          +

          period_start

          Yes

          +

          Long integer

          Long integer

          -

          Start time

          +

          Start time

          bps_in

          +

          bps_in

          Yes

          +

          Integer

          Integer

          -

          Inbound traffic (bit/s)

          +

          Inbound traffic (bit/s)

          bps_attack

          +

          bps_attack

          Yes

          +

          Integer

          Integer

          -

          Attack traffic (bit/s)

          +

          Attack traffic (bit/s)

          total_bps

          +

          total_bps

          Yes

          +

          Integer

          Integer

          -

          Total traffic

          +

          Total traffic

          pps_in

          +

          pps_in

          Yes

          +

          Integer

          Integer

          -

          Inbound packet rate (number of packets per second)

          +

          Inbound packet rate (number of packets per second)

          pps_attack

          +

          pps_attack

          Yes

          +

          Integer

          Integer

          -

          Attack packet rate (number of packets per second)

          +

          Attack packet rate (number of packets per second)

          total_pps

          +

          total_pps

          Yes

          +

          Integer

          Integer

          -

          Total packet rate

          +

          Total packet rate

          Parameter

          +
          - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/antiddos/api-ref/antiddos_02_0027.html b/docs/antiddos/api-ref/antiddos_02_0027.html index ce8f5241..73127d73 100644 --- a/docs/antiddos/api-ref/antiddos_02_0027.html +++ b/docs/antiddos/api-ref/antiddos_02_0027.html @@ -91,92 +91,74 @@
          • Data structure description of weekdata -

          Parameter

          Mandatory

          +

          Type

          Type

          -

          Description

          +

          Description

          start_time

          +

          start_time

          Yes

          +

          Long integer

          Long integer

          -

          Start time

          +

          Start time

          end_time

          +

          end_time

          Yes

          +

          Long integer

          Long integer

          -

          End time

          +

          End time

          status

          +

          status

          Yes

          +

          Integer

          Integer

          -
          Defense status, the possible value of which is one of the following:
          • 1: indicates that traffic cleaning is underway.
          • 2: indicates that traffic is discarded.
          +
          Defense status, the possible value of which is one of the following:
          • 1: indicates that traffic cleaning is underway.
          • 2: indicates that traffic is discarded.

          trigger_bps

          +

          trigger_bps

          Yes

          +

          Integer

          Integer

          -

          Traffic at the triggering point

          +

          Traffic at the triggering point

          trigger_pps

          +

          trigger_pps

          Yes

          +

          Integer

          Integer

          -

          Packet rate at the triggering point

          +

          Packet rate at the triggering point

          trigger_http_pps

          +

          trigger_http_pps

          Yes

          +

          Integer

          Integer

          -

          HTTP request rate at the triggering point

          +

          HTTP request rate at the triggering point

          Parameter

          +
          - - - - - - - - - - - - - - - - - - - - - - -

          Parameter

          Mandatory

          +

          Type

          Type

          -

          Description

          +

          Description

          ddos_intercept_times

          +

          ddos_intercept_times

          Yes

          +

          Integer

          Integer

          -

          Number of DDoS attacks blocked

          +

          Number of DDoS attacks blocked

          ddos_blackhole_times

          +

          ddos_blackhole_times

          Yes

          +

          Integer

          Integer

          -

          Number of DDoS black holes

          +

          Number of DDoS black holes

          max_attack_bps

          +

          max_attack_bps

          Yes

          +

          Integer

          Integer

          -

          Maximum attack traffic

          +

          Maximum attack traffic

          max_attack_conns

          +

          max_attack_conns

          Yes

          +

          Integer

          Integer

          -

          Maximum number of attack connections

          +

          Maximum number of attack connections

          period_start_date

          +

          period_start_date

          Yes

          +

          Long integer

          Long integer

          -

          Start time

          +

          Start time
          -
          • Data structure description of top10 -

            Parameter

            +
            • Data structure description of top10 +
              - - - - - - - - - - - diff --git a/docs/antiddos/api-ref/antiddos_02_0034.html b/docs/antiddos/api-ref/antiddos_02_0034.html index a4d1f74f..19a1f871 100644 --- a/docs/antiddos/api-ref/antiddos_02_0034.html +++ b/docs/antiddos/api-ref/antiddos_02_0034.html @@ -2,13 +2,18 @@

              Change History

              -

              Parameter

              Mandatory

              +

              Type

              Type

              -

              Description

              +

              Description

              floating_ip_address

              +

              floating_ip_address

              Yes

              +

              String

              String

              -

              EIP

              +

              EIP

              times

              +

              times

              Yes

              +

              Integer

              Integer

              -

              Number of DDoS attacks intercepted, including cleaning operations and black holes

              +

              Number of DDoS attacks intercepted, including cleaning operations and black holes

              Release Date

              +
              - + + + diff --git a/docs/antiddos/api-ref/antiddos_02_0037.html b/docs/antiddos/api-ref/antiddos_02_0037.html index 825814e0..89c71f69 100644 --- a/docs/antiddos/api-ref/antiddos_02_0037.html +++ b/docs/antiddos/api-ref/antiddos_02_0037.html @@ -32,60 +32,48 @@

              Request

              Request parameters

              None

              -

              Response

              • Parameter description -

              Release Date

              Description

              2024-03-29

              +

              2024-09-13

              +

              Updated the response parameters for Querying the list of defense statuses of EIPs.

              +

              2024-03-29
              • Optimized the response parameters in section "Querying Alarm Configuration Information".
              • Added an example response in section "Updating Alarm Configuration Information".

              Parameter

              +

              Response Messages

              • Parameter description +
                - - - - - - - - - - - - - - - - - - - - - - -

                Parameter

                Mandatory

                +

                Type

                Type

                -

                Description

                +

                Description

                enable_L7

                +

                enable_L7

                Yes

                +

                Boolean

                Boolean

                -

                Whether to enable layer-7 protection.

                +

                Whether to enable layer-7 protection.

                traffic_pos_id

                +

                traffic_pos_id

                Yes

                +

                Integer

                Integer

                -

                Position ID of traffic. The value ranges from 1 to 9, or 99, or 33 to 36.

                +

                Position ID of traffic. The value ranges from 1 to 9, or 99, or 33 to 36.

                http_request_pos_id

                +

                http_request_pos_id

                Yes

                +

                Integer

                Integer

                -

                Position ID of number of HTTP requests. The value ranges from 1 to 15 and 33 to 36.

                +

                Position ID of number of HTTP requests. The value ranges from 1 to 15 and 33 to 36.

                cleaning_access_pos_id

                +

                cleaning_access_pos_id

                Yes

                +

                Integer

                Integer

                -

                Position ID of access limit during cleaning. The value ranges from 1 to 8, or 99, or 33 to 36.

                +

                Position ID of access limit during cleaning. The value ranges from 1 to 8, or 99, or 33 to 36.

                app_type_id

                +

                app_type_id

                Yes

                +

                Integer

                Integer

                -
                Application type ID. Possible values:
                • 0
                • 1
                +
                Application type ID. Possible values:
                • 0
                • 1