Querying Anti-DDoS Specifications
Function
This API allows you to query available Anti-DDoS defense policies. You can select a policy for Anti-DDoS traffic cleaning.
Calling Method
For details, see Calling APIs.
URI
GET /v2/{project_id}/antiddos/query-config-list
| Parameter | Mandatory | Type | Description | 
|---|---|---|---|
| project_id | Yes | String | Project ID. | 
Request Parameters
| Parameter | Mandatory | Type | Description | 
|---|---|---|---|
| X-Auth-Token | Yes | String | User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token. | 
| Content-Type | Yes | String | Content-Type request header. | 
Response Parameters
Status code: 200
| 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 connection limits. | 
| extend_ddos_config | Array of ExtendDDoSSet objects | Extended configuration list. | 
| Parameter | Type | Description | 
|---|---|---|
| traffic_pos_id | Long | Position ID of traffic. The options are as follows: 1: 10 Mbit/s; 2: 30 Mbit/s; 3: 50 Mbit/s; 4: 70 Mbit/s; 5: 100 Mbit/s; 6: 150 Mbit/s; 7: 200 Mbit/s; 8: 250 Mbit/s; 9: 300 Mbit/s; 10: 500 Mbit/s; 11: 800 Mbit/s;88: 1,000 Mbit/s; 99: default protection | 
| traffic_per_second | Long | Threshold of traffic per second (Mbit/s). | 
| packet_per_second | Long | Threshold of number of packets per second. | 
| Parameter | Type | Description | 
|---|---|---|
| http_request_pos_id | Long | Segment ID of the HTTP request counts. The value is fixed to 1. | 
| http_packet_per_second | Long | Threshold of number of HTTP requests per second. | 
| Parameter | Type | Description | 
|---|---|---|
| cleaning_access_pos_id | Long | Position ID of access limit during cleaning. The options are as follows: 1: 10 Mbit/s; 2: 30 Mbit/s; 3: 50 Mbit/s; 4: 70 Mbit/s; 5: 100 Mbit/s; 6: 150 Mbit/s; 7: 200 Mbit/s; 8: 250 Mbit/s; 9: 300 Mbit/s; 10: 500 Mbit/s; 11: 800 Mbit/s;88: 1,000 Mbit/s; 99: default protection | 
| 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. | 
| Parameter | Type | Description | 
|---|---|---|
| SetID | Long | Configuration segment ID. | 
| 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. | 
| 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
Request succeeded.
{
  "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" : [ ]
}
 Status Codes
| Status Code | Description | 
|---|---|
| 200 | Request succeeded. | 
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
 
    