vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/antiddos/api-ref/antiddos_02_0017.html
Li, Qiao 6c7c1c9d99 AntiDDoS API 20240914 version 
Reviewed-by: Belejkanic, Lukas <lukas.belejkanic@t-systems.com>
Co-authored-by: Li, Qiao <qiaoli@huawei.com>
Co-committed-by: Li, Qiao <qiaoli@huawei.com>
2024-11-06 12:22:01 +00:00

367 lines
17 KiB
HTML
Raw Blame History

<a name="antiddos_02_0017"></a><a name="antiddos_02_0017"></a>
<h1 class="topictitle1">Querying Optional Anti-DDoS Defense Policies</h1>
<div id="body40205569"><div class="section" id="antiddos_02_0017__toc460486713"><h4 class="sectiontitle">Functions</h4><p id="antiddos_02_0017__p35425694">This API allows you to query optional Anti-DDoS defense policies. Based on your service, you can select a policy for Anti-DDoS traffic scrubbing.</p>
</div>
<div class="section" id="antiddos_02_0017__section26052191"><h4 class="sectiontitle">URI</h4><ul id="antiddos_02_0017__ul50908955"><li id="antiddos_02_0017__li55527413">URI format<p id="antiddos_02_0017__p8871144665020"><a name="antiddos_02_0017__li55527413"></a><a name="li55527413"></a>GET /v1/{project_id}/antiddos/query_config_list</p>
</li><li id="antiddos_02_0017__li1426598">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0017__table48445579" frame="border" border="1" rules="all"><thead align="left"><tr id="antiddos_02_0017__row16653875"><th align="left" class="cellrowborder" valign="top" width="22.847715228477146%" id="mcps1.3.2.2.2.1.1.5.1.1"><p id="antiddos_02_0017__p6786611">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.60743925607439%" id="mcps1.3.2.2.2.1.1.5.1.2"><p id="antiddos_02_0017__p12844628">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20.617938206179375%" id="mcps1.3.2.2.2.1.1.5.1.3"><p id="antiddos_02_0017__p33781949">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.92690730926907%" id="mcps1.3.2.2.2.1.1.5.1.4"><p id="antiddos_02_0017__p51983383">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="antiddos_02_0017__row49904522"><td class="cellrowborder" valign="top" width="22.847715228477146%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="antiddos_02_0017__p15734461">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25.60743925607439%" headers="mcps1.3.2.2.2.1.1.5.1.2 "><p id="antiddos_02_0017__p66531800">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20.617938206179375%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="antiddos_02_0017__p20366724">String</p>
</td>
<td class="cellrowborder" valign="top" width="30.92690730926907%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="antiddos_02_0017__p39091944">User ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="antiddos_02_0017__section33143133"><h4 class="sectiontitle">Request</h4><p id="antiddos_02_0017__p1271919191780"><strong id="antiddos_02_0017__b1862041310511">Request parameters</strong></p>
<p id="antiddos_02_0017__p74851536202">None</p>
</div>
<div class="section" id="antiddos_02_0017__section29852746"><h4 class="sectiontitle">Response</h4><ul id="antiddos_02_0017__ul64770113"><li id="antiddos_02_0017__li46060111">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0017__table11887819" frame="border" border="1" rules="all"><thead align="left"><tr id="antiddos_02_0017__row12791742"><th align="left" class="cellrowborder" valign="top" width="37.169999999999995%" id="mcps1.3.4.2.1.1.1.4.1.1"><p id="antiddos_02_0017__p29498151">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="30.61%" id="mcps1.3.4.2.1.1.1.4.1.2"><p id="antiddos_02_0017__p62513914">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="32.22%" id="mcps1.3.4.2.1.1.1.4.1.3"><p id="antiddos_02_0017__p30462260">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="antiddos_02_0017__row51524015"><td class="cellrowborder" valign="top" width="37.169999999999995%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="antiddos_02_0017__p12695699">traffic_limited_list</p>
</td>
<td class="cellrowborder" valign="top" width="30.61%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="antiddos_02_0017__p14381235">List data structure</p>
</td>
<td class="cellrowborder" valign="top" width="32.22%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="antiddos_02_0017__p14937794">List of traffic limits</p>
</td>
</tr>
<tr id="antiddos_02_0017__row222421"><td class="cellrowborder" valign="top" width="37.169999999999995%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="antiddos_02_0017__p18016155">http_limited_list</p>
</td>
<td class="cellrowborder" valign="top" width="30.61%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="antiddos_02_0017__p25287256">List data structure</p>
</td>
<td class="cellrowborder" valign="top" width="32.22%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="antiddos_02_0017__p46581538">List of HTTP limits</p>
</td>
</tr>
<tr id="antiddos_02_0017__row16580664"><td class="cellrowborder" valign="top" width="37.169999999999995%" headers="mcps1.3.4.2.1.1.1.4.1.1 "><p id="antiddos_02_0017__p856520">connection_limited_list</p>
</td>
<td class="cellrowborder" valign="top" width="30.61%" headers="mcps1.3.4.2.1.1.1.4.1.2 "><p id="antiddos_02_0017__p49596018">List data structure</p>
</td>
<td class="cellrowborder" valign="top" width="32.22%" headers="mcps1.3.4.2.1.1.1.4.1.3 "><p id="antiddos_02_0017__p50928963">List of limits of numbers of connections</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="antiddos_02_0017__ul31605337"><li id="antiddos_02_0017__li16012578">Data structure description of <strong id="antiddos_02_0017__b84235270695528_1">traffic_limited_list</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0017__table9895475" frame="border" border="1" rules="all"><thead align="left"><tr id="antiddos_02_0017__row17224274"><th align="left" class="cellrowborder" valign="top" width="37.9%" id="mcps1.3.4.3.1.2.1.4.1.1"><p id="antiddos_02_0017__p52988976">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.22%" id="mcps1.3.4.3.1.2.1.4.1.2"><p id="antiddos_02_0017__p36757156">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="44.879999999999995%" id="mcps1.3.4.3.1.2.1.4.1.3"><p id="antiddos_02_0017__p24539659">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="antiddos_02_0017__row41555354"><td class="cellrowborder" valign="top" width="37.9%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="antiddos_02_0017__p10540538">traffic_pos_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.22%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="antiddos_02_0017__p626126015239">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="44.879999999999995%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="antiddos_02_0017__p30443021">Position ID of traffic</p>
</td>
</tr>
<tr id="antiddos_02_0017__row5551736"><td class="cellrowborder" valign="top" width="37.9%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="antiddos_02_0017__p47037497">traffic_per_second</p>
</td>
<td class="cellrowborder" valign="top" width="17.22%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="antiddos_02_0017__p3938182315247">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="44.879999999999995%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="antiddos_02_0017__p5772232">Threshold of traffic per second (Mbit/s)</p>
</td>
</tr>
<tr id="antiddos_02_0017__row51950091"><td class="cellrowborder" valign="top" width="37.9%" headers="mcps1.3.4.3.1.2.1.4.1.1 "><p id="antiddos_02_0017__p47207880">packet_per_second</p>
</td>
<td class="cellrowborder" valign="top" width="17.22%" headers="mcps1.3.4.3.1.2.1.4.1.2 "><p id="antiddos_02_0017__p3599349815255">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="44.879999999999995%" headers="mcps1.3.4.3.1.2.1.4.1.3 "><p id="antiddos_02_0017__p24102752">Threshold of number of packets per second</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="antiddos_02_0017__ul6165902"><li id="antiddos_02_0017__li55493126">Data structure description of <strong id="antiddos_02_0017__b84235270695528_3">http_limited_list</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0017__table29676093" frame="border" border="1" rules="all"><thead align="left"><tr id="antiddos_02_0017__row26366538"><th align="left" class="cellrowborder" valign="top" width="37.66%" id="mcps1.3.4.4.1.2.1.4.1.1"><p id="antiddos_02_0017__p55314834">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="17.29%" id="mcps1.3.4.4.1.2.1.4.1.2"><p id="antiddos_02_0017__p63002544">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="45.050000000000004%" id="mcps1.3.4.4.1.2.1.4.1.3"><p id="antiddos_02_0017__p2932438">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="antiddos_02_0017__row36200896"><td class="cellrowborder" valign="top" width="37.66%" headers="mcps1.3.4.4.1.2.1.4.1.1 "><p id="antiddos_02_0017__p46591446">http_request_pos_id</p>
</td>
<td class="cellrowborder" valign="top" width="17.29%" headers="mcps1.3.4.4.1.2.1.4.1.2 "><p id="antiddos_02_0017__p470492221531">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.3.4.4.1.2.1.4.1.3 "><p id="antiddos_02_0017__p51582645">Position ID of number of HTTP requests</p>
</td>
</tr>
<tr id="antiddos_02_0017__row61590629"><td class="cellrowborder" valign="top" width="37.66%" headers="mcps1.3.4.4.1.2.1.4.1.1 "><p id="antiddos_02_0017__p22785027">http_packet_per_second</p>
</td>
<td class="cellrowborder" valign="top" width="17.29%" headers="mcps1.3.4.4.1.2.1.4.1.2 "><p id="antiddos_02_0017__p493536161538">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="45.050000000000004%" headers="mcps1.3.4.4.1.2.1.4.1.3 "><p id="antiddos_02_0017__p42591759">Threshold of number of HTTP requests per second</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
<ul id="antiddos_02_0017__ul45097725"><li id="antiddos_02_0017__li3226344">Data structure description of <strong id="antiddos_02_0017__b84235270695528_5">connection_limited_list</strong>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="antiddos_02_0017__table29037097" frame="border" border="1" rules="all"><thead align="left"><tr id="antiddos_02_0017__row63040734"><th align="left" class="cellrowborder" valign="top" width="39.2%" id="mcps1.3.4.5.1.2.1.4.1.1"><p id="antiddos_02_0017__p6025849">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13.600000000000001%" id="mcps1.3.4.5.1.2.1.4.1.2"><p id="antiddos_02_0017__p8478608">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="47.199999999999996%" id="mcps1.3.4.5.1.2.1.4.1.3"><p id="antiddos_02_0017__p15678685">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="antiddos_02_0017__row62013962"><td class="cellrowborder" valign="top" width="39.2%" headers="mcps1.3.4.5.1.2.1.4.1.1 "><p id="antiddos_02_0017__p57075007">cleaning_access_pos_id</p>
</td>
<td class="cellrowborder" valign="top" width="13.600000000000001%" headers="mcps1.3.4.5.1.2.1.4.1.2 "><p id="antiddos_02_0017__p1794580015316">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="47.199999999999996%" headers="mcps1.3.4.5.1.2.1.4.1.3 "><p id="antiddos_02_0017__p584738">Position ID of access limit during cleaning</p>
</td>
</tr>
<tr id="antiddos_02_0017__row5262650"><td class="cellrowborder" valign="top" width="39.2%" headers="mcps1.3.4.5.1.2.1.4.1.1 "><p id="antiddos_02_0017__p23621468">new_connection_limited</p>
</td>
<td class="cellrowborder" valign="top" width="13.600000000000001%" headers="mcps1.3.4.5.1.2.1.4.1.2 "><p id="antiddos_02_0017__p4121372515321">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="47.199999999999996%" headers="mcps1.3.4.5.1.2.1.4.1.3 "><p id="antiddos_02_0017__p32841951">Number of new connections of a source IP address</p>
</td>
</tr>
<tr id="antiddos_02_0017__row27142108"><td class="cellrowborder" valign="top" width="39.2%" headers="mcps1.3.4.5.1.2.1.4.1.1 "><p id="antiddos_02_0017__p51027174">total_connection_limited</p>
</td>
<td class="cellrowborder" valign="top" width="13.600000000000001%" headers="mcps1.3.4.5.1.2.1.4.1.2 "><p id="antiddos_02_0017__p6366945115325">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="47.199999999999996%" headers="mcps1.3.4.5.1.2.1.4.1.3 "><p id="antiddos_02_0017__p46182839">Total number of connections of a source IP address</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="antiddos_02_0017__section2064113365187"><h4 class="sectiontitle">Example</h4><ul id="antiddos_02_0017__ul93301190197"><li id="antiddos_02_0017__li1133018951915">Example request<pre class="codeblock" id="antiddos_02_0017__codeblock5729194613189">GET /v1/67641fe6886f43fcb78edbbf0ad0b99f/antiddos/query_config_list</pre>
</li></ul>
</div>
<ul id="antiddos_02_0017__ul1633039191917"><li id="antiddos_02_0017__li14330119161911">Example response<pre class="screen" id="antiddos_02_0017__screen6780468113621">{
"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
}
],
"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": [
{
"new_connection_limited": 80,
"total_connection_limited": 700,
"http_packet_per_second": 500000,
"traffic_per_second": 1000,
"packet_per_second": 200000,
"setID": 33
},
{
"new_connection_limited": 80,
"total_connection_limited": 700,
"http_packet_per_second": 500000,
"traffic_per_second": 2000,
"packet_per_second": 200000,
"setID": 34
},
{
"new_connection_limited": 80,
"total_connection_limited": 700,
"http_packet_per_second": 500000,
"traffic_per_second": 5000,
"packet_per_second": 400000,
"setID": 35
},
{
"new_connection_limited": 80,
"total_connection_limited": 700,
"http_packet_per_second": 0,
"traffic_per_second": 0,
"packet_per_second": 0,
"setID": 36
}
]
}</pre>
</li></ul>
<div class="note" id="antiddos_02_0017__note35826456163259"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="antiddos_02_0017__p54002651163259">The <span class="parmname" id="antiddos_02_0017__parmname1071795970103924"><b>extend_ddos_config</b></span> field displays information about Anti-DDoS defense policies set by users based on their needs. </p>
</div></div>
<div class="section" id="antiddos_02_0017__section239263"><h4 class="sectiontitle">Status Code</h4><p id="antiddos_02_0017__p65146268">See <a href="antiddos_02_0031.html">Status Code</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="antiddos_02_0016.html">Anti-DDoS APIs</a></div>
</div>
</div>
View Git Blame Copy Permalink