Updated on 2024-07-09 GMT+08:00

Querying Anti-DDoS specifications

Functions

This API allows you to query optional Anti-DDoS defense policies. Based on your service, you can select a policy for Anti-DDoS traffic cleaning.

URI

  • URI format

    GET /v1/{project_id}/antiddos/query_config_list

  • Parameter description

    Parameter

    Mandatory

    Type

    Description

    project_id

    Yes

    String

    Project ID.

Request

Request parameters

None

Response

  • Parameter description

    Parameter

    Type

    Description

    traffic_limited_list

    List data structure

    List of traffic limits

    http_limited_list

    List data structure

    List of HTTP limits

    connection_limited_list

    List data structure

    List of connection limits

  • Data structure description of traffic_limited_list

    Parameter

    Type

    Description

    traffic_pos_id

    Integer

    Position ID of traffic

    traffic_per_second

    Integer

    Threshold of traffic per second (Mbit/s)

    packet_per_second

    Integer

    Threshold of number of packets per second

  • Data structure description of http_limited_list

    Parameter

    Type

    Description

    http_request_pos_id

    Integer

    Position ID of number of HTTP requests

    http_packet_per_second

    Integer

    Threshold of number of HTTP requests per second

  • Data structure description of connection_limited_list

    Parameter

    Type

    Description

    cleaning_access_pos_id

    Integer

    Position ID of access limit during cleaning

    new_connection_limited

    Integer

    Number of new connections of a source IP address

    total_connection_limited

    Integer

    Total number of connections of a source IP address

Example

  • Example request
    GET /v1/67641fe6886f43fcb78edbbf0ad0b99f/antiddos/query_config_list
  • Example response
     
    {
        "traffic_limited_list": [
            {
                "traffic_pos_id": 1,
                "traffic_per_second": 10,
                "packet_per_second": 2000
            },
            {
                "traffic_pos_id": 2,
                "traffic_per_second": 30,
                "packet_per_second": 6000
            },
        ],
        "http_limited_list": [
            {
                "http_request_pos_id": 1,
                "http_packet_per_second": 100
            },
            {
                "http_request_pos_id": 2,
                "http_packet_per_second": 150
            },
        ],
        "connection_limited_list": [
            {
                "cleaning_access_pos_id": 1,
                "new_connection_limited": 10,
                "total_connection_limited": 30
            },
            {
                "cleaning_access_pos_id": 2,
                "new_connection_limited": 20,
                "total_connection_limited": 100
            },
        ],
        "extend_ddos_config": []
    }

The extend_ddos_config field displays information about Anti-DDoS defense policies set by users based on their needs.

Status Code

See Status Code.