Help Center/ Anti-DDoS Service/ API Reference/ API/ Anti-DDoS Management/ Querying Optional Anti-DDoS Defense Policies

Updated on 2023-06-19 GMT+08:00

View PDF

Querying Optional Anti-DDoS Defense Policies

Function

URI

GET /v2/{project_id}/antiddos/query-config-list

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	poject id Minimum: 32 Maximum: 64

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	token Minimum: 32 Maximum: 2097152
Content-Type	Yes	String	Default: application/json;charset=utf8

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
traffic_limited_list	Array of TriggerBpsDict objects	List of traffic limits
http_limited_list	Array of TriggerQpsDict objects	List of HTTP limits
connection_limited_list	Array of CleanLimitDict objects	List of limits of numbers of connections
extend_ddos_config	Array of ExtendDDoSSet objects	List of extend ddos limits

**Table 4** TriggerBpsDict
Parameter	Type	Description
traffic_pos_id	Long	Position ID of traffic
traffic_per_second	Long	Threshold of traffic per second (Mbit/s)
packet_per_second	Long	Threshold of number of packets per second

**Table 5** TriggerQpsDict
Parameter	Type	Description
http_request_pos_id	Long	Position ID of number of HTTP requests
http_packet_per_second	Long	Threshold of number of HTTP requests per second

**Table 6** CleanLimitDict
Parameter	Type	Description
cleaning_access_pos_id	Long	Position ID of access limit during cleaning
new_connection_limited	Long	Number of new connections of a source IP address
total_connection_limited	Long	Total number of connections of a source IP address

**Table 7** ExtendDDoSSet
Parameter	Type	Description
SetID	Long	Position ID of config
new_connection_limited	Long	List of limits of numbers of connections
total_connection_limited	Long	List of limits of numbers of total connections
http_packet_per_second	Long	Threshold of number of HTTP requests per second
traffic_per_second	Long	Threshold of traffic per second (Mbit/s)
packet_per_second	Long	Threshold of number of packets per second

Example Requests

None

Example Responses

Status code: 200

{
  "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
  }, {
    "traffic_pos_id" : 3,
    "traffic_per_second" : 50,
    "packet_per_second" : 10000
  }, {
    "traffic_pos_id" : 4,
    "traffic_per_second" : 70,
    "packet_per_second" : 15000
  }, {
    "traffic_pos_id" : 5,
    "traffic_per_second" : 100,
    "packet_per_second" : 20000
  }, {
    "traffic_pos_id" : 6,
    "traffic_per_second" : 150,
    "packet_per_second" : 25000
  }, {
    "traffic_pos_id" : 7,
    "traffic_per_second" : 200,
    "packet_per_second" : 35000
  }, {
    "traffic_pos_id" : 8,
    "traffic_per_second" : 250,
    "packet_per_second" : 50000
  }, {
    "traffic_pos_id" : 9,
    "traffic_per_second" : 300,
    "packet_per_second" : 70000
  }, {
    "traffic_pos_id" : 88,
    "traffic_per_second" : 1000,
    "packet_per_second" : 300000
  } ],
  "http_limited_list" : [ {
    "http_request_pos_id" : 1,
    "http_packet_per_second" : 100
  }, {
    "http_request_pos_id" : 2,
    "http_packet_per_second" : 150
  }, {
    "http_request_pos_id" : 3,
    "http_packet_per_second" : 240
  }, {
    "http_request_pos_id" : 4,
    "http_packet_per_second" : 350
  }, {
    "http_request_pos_id" : 5,
    "http_packet_per_second" : 480
  }, {
    "http_request_pos_id" : 6,
    "http_packet_per_second" : 550
  }, {
    "http_request_pos_id" : 7,
    "http_packet_per_second" : 700
  }, {
    "http_request_pos_id" : 8,
    "http_packet_per_second" : 850
  }, {
    "http_request_pos_id" : 9,
    "http_packet_per_second" : 1000
  }, {
    "http_request_pos_id" : 10,
    "http_packet_per_second" : 1500
  }, {
    "http_request_pos_id" : 11,
    "http_packet_per_second" : 2000
  }, {
    "http_request_pos_id" : 12,
    "http_packet_per_second" : 3000
  }, {
    "http_request_pos_id" : 13,
    "http_packet_per_second" : 5000
  }, {
    "http_request_pos_id" : 14,
    "http_packet_per_second" : 10000
  }, {
    "http_request_pos_id" : 15,
    "http_packet_per_second" : 20000
  } ],
  "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
  }, {
    "cleaning_access_pos_id" : 3,
    "new_connection_limited" : 30,
    "total_connection_limited" : 200
  }, {
    "cleaning_access_pos_id" : 4,
    "new_connection_limited" : 40,
    "total_connection_limited" : 250
  }, {
    "cleaning_access_pos_id" : 5,
    "new_connection_limited" : 50,
    "total_connection_limited" : 300
  }, {
    "cleaning_access_pos_id" : 6,
    "new_connection_limited" : 60,
    "total_connection_limited" : 500
  }, {
    "cleaning_access_pos_id" : 7,
    "new_connection_limited" : 70,
    "total_connection_limited" : 600
  }, {
    "cleaning_access_pos_id" : 8,
    "new_connection_limited" : 80,
    "total_connection_limited" : 700
  } ],
  "extend_ddos_config" : [ ]
}